Add or update frontmatter to concepts, revise tags for Prefect Cloud

PrefectHQ · Mar 31, 2022 · 2d8b36d · 2d8b36d
1 parent e5a240f
commit 2d8b36d
Show file tree

Hide file tree

Showing 19 changed files with 108 additions and 11 deletions.
diff --git a/docs/concepts/database.md b/docs/concepts/database.md
@@ -1,5 +1,5 @@
 ---
-description: Overview of Orion metadata database use and configuration.
+description: Learn more about Prefect Orion database use and configuration.
 tags:
     - Orion
     - database

diff --git a/docs/concepts/deployments.md b/docs/concepts/deployments.md
@@ -1,3 +1,16 @@
+---
+description: Prefect flow deployments encapsulate a flow, allowing it to be scheduled and triggered via API.
+tags:
+    - Orion
+    - work queues
+    - agents
+    - orchestration
+    - flow runs
+    - deployments
+    - schedules
+    - tags
+---
+
 # Deployments
 
 A deployment is a server-side concept that encapsulates a flow, allowing it to be scheduled and triggered via API. 

diff --git a/docs/concepts/flow-runners.md b/docs/concepts/flow-runners.md
@@ -1,5 +1,5 @@
 ---
-description: Learn how to configure and use flow runners, which responsible for creating and monitoring infrastructure for flow runs associated with deployments.
+description: Prefect flow runners are responsible for creating and monitoring the infrastructure for flow runs associated with deployments.
 tags:
     - orchestration
     - flow runners

diff --git a/docs/concepts/flows.md b/docs/concepts/flows.md
@@ -1,3 +1,13 @@
+---
+description: Prefect flows are the foundational containers for workflow logic
+tags:
+    - Orion
+    - flows
+    - subflows
+    - parameters
+    - states
+---
+
 # Flows
 
 Flows are the most basic Prefect object. They are containers for workflow logic and allow users to interact with and reason about the state of their workflows. They are the only abstraction that can be interacted with, displayed, and run without needing to reference any other aspect of the Prefect engine.

diff --git a/docs/concepts/logs.md b/docs/concepts/logs.md
@@ -1,3 +1,17 @@
+---
+description: Prefect logging captures information about flows and tasks for monitoring, troubleshooting, and auditing.
+tags:
+    - Orion
+    - UI
+    - dashboard
+    - Prefect Cloud
+    - flows
+    - tasks
+    - logging
+    - log formatters
+    - configuration
+---
+
 # Logging
 
 Prefect enables you to log a variety of useful information about your flow and task runs, capturing information about your workflows for purposes such as monitoring, troubleshooting, and auditing.

diff --git a/docs/concepts/overview.md b/docs/concepts/overview.md
@@ -1,3 +1,11 @@
+---
+description: Take a deeper dive into the features of Prefect 2.0
+tags:
+    - concepts
+    - features
+    - overview
+---
+
 # Concepts Overview
 
 Getting started building and running workflows with Prefect doesn't require much more than a knowledge of Python and an intuitive understanding of "tasks" and "flows".  However, deploying and scheduling workflows as well as more advanced usage patterns do require a deeper understanding of the building blocks of Prefect.

diff --git a/docs/concepts/schedules.md b/docs/concepts/schedules.md
@@ -1,3 +1,16 @@
+---
+description: Prefect lets you schedule when to automatically create new flow runs.
+tags:
+    - Orion
+    - flows
+    - flow runs
+    - deployments
+    - schedules
+    - cron
+    - RRule
+    - iCal
+---
+
 # Schedules
 
 Schedules tell the Orion server how to automatically create new flow runs on a specified cadence.

diff --git a/docs/concepts/settings.md b/docs/concepts/settings.md
@@ -1,3 +1,12 @@
+---
+description: Prefect settings let you customize your workflow environment, including working with remote Prefect servers and Prefect Cloud.
+tags:
+    - configuration
+    - settings
+    - environment variables
+    - profiles
+---
+
 # Settings
 
 Prefect's settings are [well-documented][prefect.settings.Settings] and type-validated. By modifying these settings, users can customize various aspects of the system.

diff --git a/docs/concepts/states.md b/docs/concepts/states.md
@@ -1,3 +1,13 @@
+---
+description: Prefect states contain information about the status of a flow or task run.
+tags:
+    - orchestration
+    - flow runs
+    - task runs
+    - states
+    - status
+---
+
 # States
 
 ## Overview

diff --git a/docs/concepts/storage.md b/docs/concepts/storage.md
@@ -1,5 +1,5 @@
 ---
-description: Prefect storage configuration enables you to set up local or remote data stores used for flow code, task results, and flow results.
+description: Prefect storage configures local or remote data stores used for flow code, task results, and flow results.
 tags:
     - Orion
     - storage

diff --git a/docs/concepts/task-runners.md b/docs/concepts/task-runners.md
@@ -1,5 +1,5 @@
 ---
-description: A guide to configuring and using Prefect task runners.
+description: Task runners enable sequential, concurrent, parallel, or distributed execution of Prefect tasks.
 tags:
     - Orion
     - tasks

diff --git a/docs/concepts/tasks.md b/docs/concepts/tasks.md
@@ -1,3 +1,23 @@
+---
+description: Prefect tasks are functions that represents a discrete unit of work in a Prefect workflow.
+tags:
+    - tasks
+    - task runs
+    - functions
+    - retries
+    - caching
+    - cache keys
+    - cache key functions
+    - tags
+    - results
+    - async
+    - asynchronous execution
+    - concurrent execution
+    - concurrency
+    - concurrency limits
+    - task concurrency
+---
+
 # Tasks
 
 A task is a function that represents a discrete unit of work in a Prefect workflow. Tasks are not required &mdash; you may define Prefect workflows that consist only of flows, using regular Python statements and functions. Tasks enable you to encapsulate elements of your workflow logic in observable units that can be reused across flows and subflows. 

diff --git a/docs/concepts/work-queues.md b/docs/concepts/work-queues.md
@@ -1,5 +1,5 @@
 ---
-description: Configuring and managing work queues and agents.
+description: Prefect work queues define work to be done. Prefect agents poll a work queue for new work.
 tags:
     - Orion
     - work queues

diff --git a/docs/ui/cloud.md b/docs/ui/cloud.md
@@ -3,7 +3,7 @@ description: Learn about using Prefect Cloud, including account creation and run
 tags:
     - UI
     - dashboard
-    - Cloud
+    - Prefect Cloud
     - accounts
     - teams
     - workspaces

diff --git a/docs/ui/dashboard.md b/docs/ui/dashboard.md
@@ -4,7 +4,7 @@ tags:
     - Orion
     - UI
     - dashboard
-    - Cloud
+    - Prefect Cloud
 ---
 
 # Dashboard

diff --git a/docs/ui/filters.md b/docs/ui/filters.md
@@ -4,7 +4,7 @@ tags:
     - Orion
     - UI
     - API
-    - Cloud
+    - Prefect Cloud
     - filters
     - settings
 ---

diff --git a/docs/ui/flows-and-tasks.md b/docs/ui/flows-and-tasks.md
@@ -8,7 +8,7 @@ tags:
     - flow runs
     - deployments
     - logging
-    - Cloud
+    - Prefect Cloud
 ---
 
 # Flows and Tasks

diff --git a/docs/ui/overview.md b/docs/ui/overview.md
@@ -4,7 +4,7 @@ tags:
     - Orion
     - UI
     - dashboard
-    - Cloud
+    - Prefect Cloud
 ---
 
 # Orion UI & Cloud Overview

diff --git a/docs/ui/work-queues.md b/docs/ui/work-queues.md
@@ -5,7 +5,7 @@ tags:
     - UI
     - deployments
     - flow runs
-    - Cloud
+    - Prefect Cloud
     - work queues
     - agents
     - tags