PrefectHQ / prefect

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

Make `Deployment` overview docs more useful #15420

Open zzstoatzz opened 1 week ago

zzstoatzz commented 1 week ago

Describe the current behavior

The current Deployment overview documentation is too technical and not beginner-friendly. It focuses on showing the Deployment schema and explaining every field, which seems more appropriate for an API reference.

Describe the proposed behavior

The deployment overview should give a high level description of the deployment interface

Example Use

No response

Additional context

No response

aaazzam commented 1 day ago

Let’s keep this open. I think #15494 is an improvement but we’re not there yet, and I want to have an issue to collect more community feedback.