PrefectHQ / prefect

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

Add documentation around the run_deployment method #14422

Closed zhen0 closed 3 months ago

zhen0 commented 3 months ago

First check

Describe the issue

We have limited documentation around run_deployment (apart from in the api docs) but it is a commonly referenced and used feature. It would be useful to have some more documentation around when and how to use run_deployment.

Describe the proposed change

I'm not sure of the best place for this to go but perhaps a paragraph could be added as aprt fo teh deployment overview or composing a flow section?

Additional context

No response