PrefectHQ / prefect

Prefect is a workflow orchestration framework for building resilient data pipelines in Python.
https://prefect.io
Apache License 2.0
15.32k stars 1.5k forks source link

Every code example in the Deploy docs should include a companion YAML example #14386

Open daniel-prefect opened 3 days ago

daniel-prefect commented 3 days ago

First check

Describe the issue

YAML is how teams often want to define deploys in production. We should support this by updating our docs to show this approach alongside the traditional Python approach. The less people have to do the translation in their heads, the more successful they'll be.

Describe the proposed change

We've got a section of a page dedicated to showing how to define deployments in YAML: https://docs-3.prefect.io/3.0rc/deploy/control-runs/prefect-deploy#create-work-pool-based-deployments-with-prefect-yaml

Let's replace this with inline examples next to each code block in the Deploy docs that show the equivalent YAML for every Python example. We can use the tabs component to add YAML examples without making the pages any longer.

Additional context

No response