Skip to content

Commit 6573791

Browse files
Terrence Dorseyserinamarie
andauthored
Configure docs to enable versioning at a future time (PrefectHQ#8204)
Co-authored-by: Serina Grill <[email protected]>
1 parent 487f734 commit 6573791

29 files changed

+427
-95
lines changed

docs/concepts/deployments.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ To edit parameters in the Prefect UI, go the the details page for a deployment,
300300

301301
To create an ad-hoc flow run with different parameter values, go the the details page for a deployment, select **Run**, then select **Custom**. You will be able to provide custom values for any editable deployment fields. Under **Parameters**, select **Custom**. Provide the new values, then select **Save**. Select **Run** to begin the flow run with custom values.
302302

303-
![Configuring custom parameter values for an ad-hoc flow run](/img/concepts/custom-parameters.png)
303+
![Configuring custom parameter values for an ad-hoc flow run](../img/concepts/custom-parameters.png)
304304

305305
### Create a deployment
306306

@@ -339,7 +339,7 @@ $ prefect deployment ls
339339
```
340340
</div>
341341

342-
![Viewing deployments in the Prefect UI](/img/concepts/deployments.png)
342+
![Viewing deployments in the Prefect UI](../img/concepts/deployments.png)
343343

344344
When you run a deployed flow with Prefect Orion, the following happens:
345345

docs/concepts/flows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ However you run the flow, the Prefect API monitors the flow run, capturing flow
4747

4848
When you run a flow that contains tasks or additional flows, Prefect will track the relationship of each child run to the parent flow run.
4949

50-
![Prefect UI](/img/ui/orion-dashboard.png)
50+
![Prefect UI](../img/ui/orion-dashboard.png)
5151

5252
## Writing flows
5353

@@ -752,4 +752,4 @@ $ prefect flow-run cancel 'a55a4804-9e3c-4042-8b59-b3b6b7618736'
752752
753753
From the UI you can cancel a flow run by navigating to the flow run's detail page and clicking the `Cancel` button in the upper right corner.
754754
755-
![Prefect UI](/img/ui/flow-run-cancellation-ui.png)
755+
![Prefect UI](../img/ui/flow-run-cancellation-ui.png)

docs/concepts/logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Completed('All states completed.')
4747

4848
You can see logs for the flow run in the Prefect UI by navigating to the [**Flow Runs**](/ui/flow-runs/#inspect-a-flow-run) page and selecting a specific flow run to inspect.
4949

50-
![Viewing logs for a flow run in the Prefect UI](/img/ui/orion-flow-run-details.png)
50+
![Viewing logs for a flow run in the Prefect UI](../img/ui/orion-flow-run-details.png)
5151

5252
These log messages reflect the logging configuration for log levels and message formatters. You may customize the log levels captured and the default message format through configuration, and you can capture custom logging events by explicitly emitting log messages during flow and task runs.
5353

docs/concepts/storage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ You can [create, edit, and manage storage blocks](/ui/blocks/) in the Prefect UI
6868

6969
To create a new block, select the **+** button. Prefect displays a library of block types you can configure to create blocks to be used by your flows.
7070

71-
![Viewing the new block library in the Prefect UI](/img/ui/orion-block-library.png)
71+
![Viewing the new block library in the Prefect UI](../img/ui/orion-block-library.png)
7272

7373
Select **Add +** to configure a new storage block based on a specific block type. Prefect displays a **Create** page that enables specifying storage settings.
7474

75-
![Configurating an S3 storage block in the Prefect UI](/img/tutorials/s3-block-configuration.png)
75+
![Configuring an S3 storage block in the Prefect UI](../img/tutorials/s3-block-configuration.png)
7676

7777
You can also create blocks using the Prefect Python API:
7878

docs/concepts/work-queues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ You can configure work queues by using:
139139
- Prefect CLI commands
140140
- Prefect Python API
141141
142-
![Creating a new work queue in the Orion UI](/img/ui/work-queue-create.png)
142+
![Creating a new work queue in the Orion UI](../img/ui/work-queue-create.png)
143143
144144
145145
To configure a work queue via the Prefect CLI, use the `prefect work-queue create` command:
@@ -183,7 +183,7 @@ On success, the command returns the details of the newly created work queue, whi
183183
184184
At any time, users can see and edit configured work queues in the Prefect UI.
185185
186-
![The UI displays a list of configured work queues](/img/ui/work-queue-list.png)
186+
![The UI displays a list of configured work queues](../img/ui/work-queue-list.png)
187187
188188
To view work queues with the Prefect CLI, you can:
189189

docs/tutorials/deployments.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -531,30 +531,30 @@ Note that we referenced the deployment by name in the format "flow_name/deployme
531531

532532
You can also see your flow in the [Prefect UI](/ui/overview/). Open the Prefect UI at [http://127.0.0.1:4200/](http://127.0.0.1:4200/). You'll see your deployment's flow run in the UI.
533533

534-
![Deployment flow run on the Flow Runs page of the Prefect UI](/img/tutorials/my-first-deployment.png)
534+
![Deployment flow run on the Flow Runs page of the Prefect UI](../img/tutorials/my-first-deployment.png)
535535

536536
## Run a deployment from the UI
537537

538538
With a work queue and agent in place, you can also create a flow run for `log_simple` directly from the UI.
539539

540540
In the Prefect UI, select the **Deployments** page. You'll see a list of all deployments that have been created in this Prefect Orion instance.
541541

542-
![The Deployments page displays a list of deployments created in Prefect](/img/tutorials/orion-deployments.png)
542+
![The Deployments page displays a list of deployments created in Prefect](../img/tutorials/orion-deployments.png)
543543

544544
Now select **log-flow/log-simple** to see details for the deployment you just created.
545545

546-
![Viewing details of a single deployment](/img/tutorials/deployment-details.png)
546+
![Viewing details of a single deployment](../img/tutorials/deployment-details.png)
547547

548548
Select **Parameters** to see the default parameters you specified in the deployment definition.
549549

550-
![Viewing deployment parameters](/img/tutorials/deployment-parameters.png)
550+
![Viewing deployment parameters](../img/tutorials/deployment-parameters.png)
551551

552552
You can start a flow run for this deployment from the UI by selecting the **Run** button, which gives you options to:
553553

554554
- Create a flow run with the default settings
555555
- Create a flow run with custom settings
556556

557-
![Deployment run options in the UI](/img/tutorials/deployment-run-options.png)
557+
![Deployment run options in the UI](../img/tutorials/deployment-run-options.png)
558558

559559
If you choose a **Custom** flow run, you can configure details including:
560560

@@ -564,13 +564,13 @@ If you choose a **Custom** flow run, you can configure details including:
564564
- Scheduled start time
565565
- Custom parameters
566566

567-
![Configuring custom flow run settings](/img/tutorials/custom-flow-run.png)
567+
![Configuring custom flow run settings](../img/tutorials/custom-flow-run.png)
568568

569569
Let's change the `name` parameter for the next flow run. Under **Parameters**, select **Custom**.
570570

571571
Change the value for the `name` parameter to some other value. We used "Trillian".
572572

573-
![Configuring custom flow run settings](/img/tutorials/custom-parameter.png)
573+
![Configuring custom flow run settings](../img/tutorials/custom-parameter.png)
574574

575575
Select **Save** to save any changed values, then select **Run** to create the custom flow run.
576576

@@ -606,11 +606,11 @@ As before, the flow run will be picked up by the agent, and you should be able t
606606

607607
Go back the **Flow Runs** page in the UI and you'll see the flow run you just initiatied ran and was observed by the API.
608608

609-
![The deployment flow run is shown in the UI run history](/img/tutorials/deployment-run.png)
609+
![The deployment flow run is shown in the UI run history](../img/tutorials/deployment-run.png)
610610

611611
Select the flow run to see details. In the flow run logs, you can see that the flow run logged a "Hello Trillian!" message as expected.
612612

613-
![The flow run logs show the expected Hello Trillian! log message](/img/tutorials/dep-flow-logs.png)
613+
![The flow run logs show the expected Hello Trillian! log message](../img/tutorials/dep-flow-logs.png)
614614

615615
## Run deployments with Prefect Cloud
616616

docs/tutorials/docker.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ Most users will find it easiest to configure new infrastructure blocks through t
4343

4444
You can see any previously configured storage blocks by opening the Prefect UI and navigating to the **Blocks** page. To create a new infrastructure block, select the **+** button on this page. Prefect displays a page of available block types. Select **run-infrastructure** from the **Capability** list to filter just the infrastructure blocks.
4545

46-
![Viewing a list of infrastructure block types in the Prefect UI](/img/tutorials/infrastructure-blocks.png)
46+
![Viewing a list of infrastructure block types in the Prefect UI](../img/tutorials/infrastructure-blocks.png)
4747

4848
Use these base blocks to create your own infrastructure blocks containing the settings needed to run flows in your environment.
4949

5050
For this tutorial, find the **Docker Container** block, then select **Add +** to see the options for a Docker infrastructure block.
5151

52-
![Viewing a list of infrastructure block types in the Prefect UI](/img/tutorials/docker-infrastructure.png)
52+
![Viewing a list of infrastructure block types in the Prefect UI](../img/tutorials/docker-infrastructure.png)
5353

5454
To configure this Docker Container block to run the `log_flow.py` deployment, we just need to add two pieces of information.
5555

@@ -70,7 +70,7 @@ In the **Env (Optional)** box, enter the following to specify that the `s3fs` pa
7070
```
7171
If you defined a different type of storage block, such as Azure or GCS, you'll need to specify the relevant storage library. See the [Prerequisites section of the Storage tutorial](/tutorials/storage/#prerequisites) for details.
7272

73-
![Configuring a new Docker Container infrastructure block in the Prefect UI](/img/tutorials/docker-tutorial-block.png)
73+
![Configuring a new Docker Container infrastructure block in the Prefect UI](../img/tutorials/docker-tutorial-block.png)
7474

7575
## Using infrastructure blocks with deployments
7676

@@ -127,21 +127,21 @@ $ prefect agent start -q 'test'
127127

128128
Open the Prefect UI at [http://127.0.0.1:4200/](http://127.0.0.1:4200/) and select the **Deployments** page. You'll see a list of all deployments that have been created in this Prefect Orion instance, including the new `log-flow/log-flow-docker` deployment.
129129

130-
![Viewing the new Docker deployment in the Prefect UI](/img/tutorials/docker-deployment.png)
130+
![Viewing the new Docker deployment in the Prefect UI](../img/tutorials/docker-deployment.png)
131131

132132
## Edit the deployment in the UI
133133

134134
`log_flow` expects a runtime parameter for its greeting, and we didn't provide one as part of this deployment yet. We could edit `log-flow-docker-deployment.yaml` to add a parameter and apply the edited YAML to update the deployment on the API.
135135

136136
Instead, let's edit the deployment through the Prefect UI. Select **log-flow/log-flow-docker** to see the deployment's details.
137137

138-
![Viewing the Docker deployment details in the Prefect UI](/img/tutorials/docker-deployment-details.png)
138+
![Viewing the Docker deployment details in the Prefect UI](../img/tutorials/docker-deployment-details.png)
139139

140140
Select the menu next to **Run**, then select **Edit** to edit the deployment.
141141

142142
Scroll down to the **Parameters** section and provide a value for the `name` parameter. We used "Ford Prefect" here.
143143

144-
![Editing the Docker deployment details in the Prefect UI](/img/tutorials/edit-docker-deployment.png)
144+
![Editing the Docker deployment details in the Prefect UI](../img/tutorials/edit-docker-deployment.png)
145145

146146
Select **Save** to save these changes to the deployment.
147147

@@ -181,7 +181,7 @@ Let's create a flow run for this deployment. The flow run will execute in a Dock
181181

182182
On the deployment details page, select **Run**, then select **Now with defaults**. This creates a new flow run using the default parameters and other settings.
183183

184-
![Running the Docker deployment from the Prefect UI](/img/tutorials/run-docker-deployment.png)
184+
![Running the Docker deployment from the Prefect UI](../img/tutorials/run-docker-deployment.png)
185185

186186
Go to the terminal session running the Prefect agent. You should see logged output showing:
187187

@@ -214,7 +214,7 @@ Collecting s3fs
214214

215215
In the Prefect Orion UI, go to the **Flow Runs** page and select the flow run. You should see the "Hello Ford Prefect!" log message created by the flow running in the Docker container!
216216

217-
![Log messages from the deployment flow run.](/img/tutorials/docker-flow-log.png)
217+
![Log messages from the deployment flow run.](../img/tutorials/docker-flow-log.png)
218218

219219
## Cleaning up
220220

docs/tutorials/first-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ $ prefect orion start
230230

231231
Open the URL for the Orion UI ([http://127.0.0.1:4200](http://127.0.0.1:4200) by default) in a browser. You should see all of the runs that we have run throughout this tutorial, including one for `common_flow`:
232232

233-
![Viewing the orchestrated flow runs in the Orion UI.](/img/tutorials/first-steps-ui.png)
233+
![Viewing the orchestrated flow runs in the Orion UI.](../img/tutorials/first-steps-ui.png)
234234

235235
The Prefect UI and Prefect Cloud provide an overview of all of your flows, flow runs, and task runs, plus a lot more. For details on using the Prefect UI, see the [Prefect UI & Prefect Cloud](/ui/overview/) documentation.
236236

docs/tutorials/kubernetes-flow-runner.md.old

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -244,11 +244,11 @@ Created flow run 'poetic-scorpion' (adb711df-e005-41c7-a822-9cb3ae2704f4)
244244

245245
You can also run the flow from the Prefect Orion UI. Open a browser tab and navigate to [http://127.0.0.1:4200](http://127.0.0.1:4200). You should see the flow run deployment “my-kubernetes-flow” and a successful flow run.
246246

247-
![Screenshot showing the "my-kubernetes-flow" flow](/img/tutorials/k8s-test-flow.png)
247+
![Screenshot showing the "my-kubernetes-flow" flow](../img/tutorials/k8s-test-flow.png)
248248

249249
Click **Deployments** to see the entry for this deployment, `k8s-example`. You can run the flow interactively using the **Quick Run** button.
250250

251-
![Screenshot showing deployed “k8s-example” deployment](/img/tutorials/k8s-test-deploy.png)
251+
![Screenshot showing deployed “k8s-example” deployment](../img/tutorials/k8s-test-deploy.png)
252252

253253
Go ahead and kick off an ad-hoc flow run: click **Quick Run** to run the deployment a second time.
254254

@@ -258,11 +258,11 @@ Let's take a closer look at the `my-kubernetes-flow` flow runs we created from t
258258

259259
Click **Flow Runs** to see that we did, in fact, create two flow runs that executed as Kubernetes Jobs.
260260

261-
![Screenshot showing flow runs for “k8s-example”](/img/tutorials/k8s-flow-runs.png)
261+
![Screenshot showing flow runs for “k8s-example”](../img/tutorials/k8s-flow-runs.png)
262262

263263
Now select one of the flow runs by clicking on the flow run name &mdash; in this case I clicked "poetic-scorpion". Your flow names will be different.
264264

265-
![Screenshot showing details for the "poetic-scorpion" flow run](/img/tutorials/k8s-flow-run-logs.png)
265+
![Screenshot showing details for the "poetic-scorpion" flow run](../img/tutorials/k8s-flow-run-logs.png)
266266

267267
Go to the **Logs** tab of your flow run. You should see the "Hello from Kubernetes!" log message created by the flow running in Kubernetes!
268268

docs/tutorials/orion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ See the [Database](/concepts/database/) documentation for further details on cho
166166

167167
The [Prefect UI](/ui/overview/) comes prepackaged with the Prefect Orion API when you serve it. By default it can be found at `http://127.0.0.1:4200/`:
168168

169-
![Prefect Orion UI dashboard.](/img/ui/orion-dashboard.png)
169+
![Prefect Orion UI dashboard.](../img/ui/orion-dashboard.png)
170170

171171
The UI enables you to track and manage your flows, runs, and deployments and additionally allows you to filter by names, tags, and other metadata to quickly find the information you are looking for.
172172

0 commit comments

Comments
 (0)