Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Deployment overview docs more useful #15420

Open
zzstoatzz opened this issue Sep 18, 2024 · 0 comments
Open

Make Deployment overview docs more useful #15420

zzstoatzz opened this issue Sep 18, 2024 · 0 comments
Labels
docs enhancement An improvement of an existing feature

Comments

@zzstoatzz
Copy link
Collaborator

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

  • what is a deployment?
  • why do they matter?
  • who do they matter for? ie operators / authors
  • static vs dynamic infra?

Example Use

No response

Additional context

No response

@zzstoatzz zzstoatzz added enhancement An improvement of an existing feature docs labels Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement An improvement of an existing feature
Projects
None yet
Development

No branches or pull requests

1 participant