Skip to content

Commit

Permalink
Preferentially use 'flow' over 'workflow' when referring to Prefect f…
Browse files Browse the repository at this point in the history
…lows
  • Loading branch information
djsauble committed Jun 14, 2024
1 parent 057a62f commit 9fbc297
Show file tree
Hide file tree
Showing 51 changed files with 184 additions and 184 deletions.
4 changes: 2 additions & 2 deletions docs/3.0rc/api-ref/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ description: Explore Prefect's auto-generated reference documentation.

Prefect auto-generates reference documentation for the following components:

- **[Prefect Python SDK](https://prefect-python-sdk-docs.netlify.app/)**: used to build, test, and execute workflows.
- **Prefect REST API**: used by workflow clients and the Prefect UI for orchestration and data retrieval.
- **[Prefect Python SDK](https://prefect-python-sdk-docs.netlify.app/)**: used to build, test, and execute flows.
- **Prefect REST API**: used by clients and the Prefect UI for orchestration and data retrieval.
- Prefect Cloud REST API documentation is available at <a href="https://app.prefect.cloud/api/docs" target="_blank">https://app.prefect.cloud/api/docs</a>.
- The REST API documentation for a locally hosted open-source Prefect server is available in the [Prefect REST API Reference](3.0rc/api-ref/server).

Expand Down
2 changes: 1 addition & 1 deletion docs/3.0rc/api-ref/python/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ tags:

# Python SDK

The Prefect Python SDK is used to build, test, and execute workflows against the Prefect API.
The Prefect Python SDK is used to build, test, and execute flows against the Prefect API.

Interact with docs [here](https://prefect-python-sdk-docs.netlify.app/).
2 changes: 1 addition & 1 deletion docs/3.0rc/api-ref/server/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ tags:

# Server API

The Prefect server API is used by the server to work with workflow metadata and enforce orchestration logic. This API is primarily used by Prefect developers.
The Prefect server API is used by the server to work with flow metadata and enforce orchestration logic. This API is primarily used by Prefect developers.

Select links in the left navigation menu to explore.
6 changes: 3 additions & 3 deletions docs/3.0rc/cloud/configure-client.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Profiles and configuration
description: Prefect settings let you customize your workflow environment, including working with Prefect server and Prefect Cloud.
description: Prefect settings let you customize your environment, including working with Prefect server and Prefect Cloud.
---

Learn how to configure your Prefect local settings to customize your workflow environment.
Learn how to configure your Prefect local settings to customize your environment.

{/* These settings are type-validated and [documented][prefect.settings.Settings.] */}

Expand Down Expand Up @@ -131,7 +131,7 @@ If running a self-hosted Prefect server instance, there are several [database co

### Logging settings

Prefect provides several [logging configuration settings](/3.0rc/develop/observe-workflows/logging/).
Prefect provides several [logging configuration settings](/3.0rc/develop/observe-flows/logging/).

## Configure settings

Expand Down
14 changes: 7 additions & 7 deletions docs/3.0rc/cloud/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Observe and orchestrate your workflow applications with the hosted

Prefect Cloud is a hosted workflow application framework that provides all the capabilities of Prefect server plus additional features, such as:

- automations, events, and webhooks so you can create event-driven workflows
- automations, events, and webhooks so you can create event-driven flows
- workspaces, RBAC, SSO, audit logs and related user management tools for collaboration
- push work pools for running flows on serverless infrastructure without a worker
- error summaries powered by Marvin AI to help you resolve errors faster
Expand Down Expand Up @@ -67,9 +67,9 @@ See the [Workspaces](/3.0rc/cloud/workspaces/) documentation for more informatio

Each workspace keeps track of its own:

- [Flow runs](/3.0rc/develop/write-workflows/) and task runs executed in an environment that is [syncing with the workspace](/3.0rc/cloud/workspaces/)
- [Flows](/3.0rc/develop/write-workflows/) associated with flow runs and deployments observed by the Prefect Cloud API
- [Deployments](/3.0rc/deploy/serve-workflows/)
- [Flow runs](/3.0rc/develop/write-flows/) and task runs executed in an environment that is [syncing with the workspace](/3.0rc/cloud/workspaces/)
- [Flows](/3.0rc/develop/write-flows/) associated with flow runs and deployments observed by the Prefect Cloud API
- [Deployments](/3.0rc/deploy/serve-flows/)
- [Work pools](/3.0rc/deploy/dynamic-infra/control-runs/)
- [Blocks](/3.0rc/develop/connect-third-party/)
- [Events](/3.0rc/react/understand-events/)
Expand All @@ -80,18 +80,18 @@ Each workspace keeps track of its own:

## Events

Prefect Cloud allows you to see your [events](/3.0rc/react/understand-events/). Events provide information about the state of your workflows, and can be used as [automation](/3.0rc/react/understand-events/automations-triggers/) triggers.
Prefect Cloud allows you to see your [events](/3.0rc/react/understand-events/). Events provide information about the state of your flows, and can be used as [automation](/3.0rc/react/understand-events/automations-triggers/) triggers.

![Prefect UI](/3.0rc/img/ui/event-feed.png)

## Automations

Prefect Cloud [automations](/3.0rc/react/understand-events/automations-triggers/) provide additional notification capabilities beyond those in a self-hosted open-source Prefect server.
Automations also enable you to create event-driven workflows, toggle resources such as schedules and work pools, and declare incidents.
Automations also enable you to create event-driven flows, toggle resources such as schedules and work pools, and declare incidents.

## Incidents <span class="badge pro"></span> <span class="badge custom"></span>

Prefect Cloud's [incidents](/3.0rc/react/manage-events/) help teams identify, rectify, and document issues in mission-critical workflows.
Prefect Cloud's [incidents](/3.0rc/react/manage-events/) help teams identify, rectify, and document issues in mission-critical flows.
Incidents are formal declarations of disruptions to a workspace.
With [automations](/3.0rc/react/manage-events/#incident-automations)), activity in that workspace can be paused when an incident is created and resumed when it is resolved.

Expand Down
2 changes: 1 addition & 1 deletion docs/3.0rc/cloud/rate-limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The retention period applies to all workspaces that belong to the account.

The retention period is the number of days that metadata is available after it is created.
For flow and task runs, it is calculated from the time the run reaches a
[terminal state](/3.0rc/develop/observe-workflows/manage-states/#state-types).
[terminal state](/3.0rc/develop/observe-flows/manage-states/#state-types).
Subflow runs are retained independently from their parent flow runs. They are removed based on
the time each subflow run reaches a terminal state.

Expand Down
2 changes: 1 addition & 1 deletion docs/3.0rc/cloud/self-host.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ Prefect Cloud has an option for automation notifications. The more limited Notif
self-hosted Prefect server.

Notifications enable you to set up alerts that are sent when a flow enters any state you specify.
When your flow and task runs changes [state](/3.0rc/develop/observe-workflows/manage-states/),
When your flow and task runs changes [state](/3.0rc/develop/observe-flows/manage-states/),
Prefect notes the state change and checks whether the new state matches any notification policies. If it does, a new notification is queued.

Prefect supports sending notifications through:
Expand Down
4 changes: 2 additions & 2 deletions docs/3.0rc/cloud/troubleshoot-cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ They should be upgraded simultaneously with the core library, using the same met

## Logs

In many cases, there is an informative stack trace in Prefect's [logs](/3.0rc/develop/observe-workflows/logging/).
In many cases, there is an informative stack trace in Prefect's [logs](/3.0rc/develop/observe-flows/logging/).
**Read it carefully**, locate the source of the error, and try to identify the cause.

There are two types of logs:
Expand Down Expand Up @@ -203,7 +203,7 @@ Insufficient permissions result in an error. For example, starting a worker with

The user can execute flows locally, or remotely by a worker. Local execution generally means that you, the user,
run your flow directly with a command like `python flow.py`. Remote execution generally means that a worker runs your flow
through a [deployment](/3.0rc/deploy/serve-workflows/) (optionally on different infrastructure).
through a [deployment](/3.0rc/deploy/serve-flows/) (optionally on different infrastructure).

With remote execution, the creation of your flow run happens separately from its execution.
Flow runs are assigned to a work pool and a work queue. For flow runs to execute, a worker must be subscribed
Expand Down
4 changes: 2 additions & 2 deletions docs/3.0rc/deploy/dynamic-infra/deploy-ci-cd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ search:
boost: 2
---

Many organizations deploy Prefect workflows through their CI/CD process.
Many organizations deploy Prefect flows through their CI/CD process.
Each organization has their own unique CI/CD setup, but a common pattern is to use CI/CD to manage
Prefect [deployments](/3.0rc/deploy/serve-workflows).
Prefect [deployments](/3.0rc/deploy/serve-flows).
Combining Prefect's deployment features with CI/CD tools enables efficient management of flow code
updates, scheduling changes, and container builds.
This guide uses [GitHub Actions](https://docs.github.com/en/actions) to implement a CI/CD process,
Expand Down
10 changes: 5 additions & 5 deletions docs/3.0rc/deploy/dynamic-infra/deploy-docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Run Flows with Docker
description: Learn how to store your flow code in a Docker image and serve your flow on any docker-compatible infrastructure.
---

The [Deployments](/3.0rc/deploy/serve-workflows/) guide showed how to serve a flow on a schedule.
The [Deployments](/3.0rc/deploy/serve-flows/) guide showed how to serve a flow on a schedule.

With a Python script, you can build a Docker image for that script, allowing you to serve your flow
This guide demonstrates running a flow in Kubernetes, but you can use any Docker-compatible
Expand Down Expand Up @@ -43,7 +43,7 @@ if __name__ == "__main__":
## Prerequisites

- A Python script that defines and serves a flow. This guide uses the flow script and
deployment from the [Deployments](/3.0rc/deploy/serve-workflows/) guide.
deployment from the [Deployments](/3.0rc/deploy/serve-flows/) guide.
- Access to a running Prefect API server. Sign up for a forever free
[Prefect Cloud account](https://docs.prefect.io/cloud/), or run a Prefect API server
locally with `prefect server start`.
Expand All @@ -59,7 +59,7 @@ cd prefect-docker-guide
```

In this directory, create a sub-directory named `flows` and put your flow script
from the [Deployments](/3.0rc/deploy/serve-workflows/) guide in it.
from the [Deployments](/3.0rc/deploy/serve-flows/) guide in it.

```bash
mkdir flows
Expand Down Expand Up @@ -432,8 +432,8 @@ not when a flow's code changes.
- You can extend this setup to serve
multiple flows in a single Docker image by updating your Python script to use
`flow.to_deployment` and `serve` to [serve multiple flows or the same flow with
different configuration](/3.0rc/develop/write-workflows#serving-multiple-flows-at-once).
- To learn more about deploying flows, check out the [Deployments](/3.0rc/deploy/serve-workflows/)
different configuration](/3.0rc/develop/write-flows#serving-multiple-flows-at-once).
- To learn more about deploying flows, check out the [Deployments](/3.0rc/deploy/serve-flows/)
concept doc.
- For advanced infrastructure requirements, such as executing each flow run within its own dedicated
Docker container, learn more in the [Work pool deployment guide](/3.0rc/guides/prefect-deploy/).
2 changes: 1 addition & 1 deletion docs/3.0rc/deploy/dynamic-infra/deploy-kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ steps.
To learn about the Python deployment creation method with `flow.deploy` see
[Workers](/3.0rc/deploy/dynamic-infra/push-runs-remote/).

The [`prefect.yaml`](/3.0rc/deploy/serve-workflows/#managing-deployments) file is used
The [`prefect.yaml`](/3.0rc/deploy/serve-flows/#managing-deployments) file is used
by the `prefect deploy` command to deploy your flows.
As a part of that process it also builds and pushes your image.
Create a new file named `prefect.yaml` with the following contents:
Expand Down
8 changes: 4 additions & 4 deletions docs/3.0rc/deploy/dynamic-infra/push-runs-remote.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Next, deploy your tutorial flow to `my-docker-pool`.

From the previous steps, you now have:

1. [A flow](/3.0rc/develop/write-workflows/)
1. [A flow](/3.0rc/develop/write-flows/)
2. A work pool
3. A worker

Expand Down Expand Up @@ -174,7 +174,7 @@ python repo_info.py
```

Prefect builds a custom Docker image containing your flow code. The worker can use it to dynamically spawn Docker
containers whenever this workflow needs to run.
containers whenever this flow needs to run.

<Note>
**Dockerfile**
Expand Down Expand Up @@ -225,7 +225,7 @@ The `job_variables` section allows you to fine-tune the infrastructure settings
default values in the specified work pool's [base job template](/3.0rc/deploy/dynamic-infra/control-runs/#base-job-template).

When testing images locally without pushing them to a registry (to avoid potential errors like docker.errors.NotFound),
we recommend including an `image_pull_policy` job_variable set to `Never`. However, for production workflows, push images to a
we recommend including an `image_pull_policy` job_variable set to `Never`. However, for production flows, push images to a
remote registry for more reliability and accessibility.

Set the `image_pull_policy` as `Never` for this test deployment without affecting the default value set on your work pool:
Expand Down Expand Up @@ -322,7 +322,7 @@ These push work pool options require connection configuration information to be
Read more in the [Serverless push work pool guide](/3.0rc/deploy/dynamic-infra/push-runs-serverless/).
</Note>

This is a brief overview of the options to run workflows on serverless infrastructure.
This is a brief overview of the options to run flows on serverless infrastructure.
For in-depth guides, see the Prefect integration libraries:

- [AWS ECS guide in the `prefect-aws` docs](https://prefecthq.github.io/prefect-aws/ecs_guide/)
Expand Down
2 changes: 1 addition & 1 deletion docs/3.0rc/deploy/dynamic-infra/push-runs-serverless.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,7 @@ Create your pool to be ready to deploy flows to your Push work pool.

## Deployment

You need to configure your [deployment](/3.0rc/deploy/serve-workflows/) to send flow runs to your push work pool.
You need to configure your [deployment](/3.0rc/deploy/serve-flows/) to send flow runs to your push work pool.
For example, if you create a deployment through the interactive command line experience,
choose the work pool you just created. If you are deploying an existing `prefect.yaml` file, the deployment would contain:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ Prefect Cloud can schedule flow runs through event-driven [automations](/3.0rc/r

You can assign multiple schedules to deployments in the Prefect UI, or the CLI with `prefect deployment schedule` commands,
the `Deployment` class, and in
[block-based deployment](/3.0rc/deploy/serve-workflows/#block-based-deployments) YAML files.
[block-based deployment](/3.0rc/deploy/serve-flows/#block-based-deployments) YAML files.

Support for multiple schedules in `flow.serve`, `flow.deploy`, `serve`, and [worker-based deployments](/3.0rc/deploy/dynamic-infra/control-runs/)
with `prefect deploy` will arrive soon.
</Tip>

Schedules automatically create new flow runs for deployed or served flows.
You can add one or more schedules to any [served or deployed](/3.0rc/deploy/serve-workflows/) flow.
You can add one or more schedules to any [served or deployed](/3.0rc/deploy/serve-flows/) flow.
Schedules tell the Prefect API when and how to create new flow runs for deployments.

You can add a schedule to a deployment in the Prefect UI, in the CLI through the `prefect deployment schedule` command, or the `prefect.yaml` configuration file.
Expand Down Expand Up @@ -98,7 +98,7 @@ Longer schedules, such as one that fires at 9am every morning, adjust for DST au

An `Interval` schedule creates new flow runs on a regular interval measured in seconds. Intervals are computed using an optional
`anchor_date`. For example, this is how you create a schedule for every 10 minutes in a
[block-based deployment](/3.0rc/deploy/serve-workflows/#block-based-deployments) YAML file:
[block-based deployment](/3.0rc/deploy/serve-flows/#block-based-deployments) YAML file:

```yaml
schedule:
Expand Down Expand Up @@ -159,7 +159,7 @@ week day or day-of-month adjustments, and more. RRules can represent complex log

You may find it useful to use an RRule string generator such as the [iCalendar.org RRule Tool](https://icalendar.org/rrule-tool.html) to help create valid RRules.

For example, the following RRule schedule in a [block-based deployment](/3.0rc/deploy/serve-workflows/#block-based-deployments)
For example, the following RRule schedule in a [block-based deployment](/3.0rc/deploy/serve-flows/#block-based-deployments)
YAML file creates flow runs on Monday, Wednesday, and Friday until July 30, 2024.

```yaml
Expand Down Expand Up @@ -189,8 +189,8 @@ There are several ways to create a schedule for a deployment:

- Through the Prefect UI
- With the `cron`, `interval`, or `rrule` parameters if building your deployment with the
[`serve` method](/3.0rc/develop/write-workflows/#serving-a-flow) of the `Flow` object or
[the `serve` utility](/3.0rc/develop/write-workflows/#serving-multiple-flows-at-once) for managing multiple flows simultaneously
[`serve` method](/3.0rc/develop/write-flows/#serving-a-flow) of the `Flow` object or
[the `serve` utility](/3.0rc/develop/write-flows/#serving-multiple-flows-at-once) for managing multiple flows simultaneously
- If using [worker-based deployments](/3.0rc/deploy/dynamic-infra/control-runs/)
- When you define a deployment with `flow.serve` or `flow.deploy`
- Through the interactive `prefect deploy` command
Expand Down
Loading

0 comments on commit 9fbc297

Please sign in to comment.