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

Define how we handle apiVersion info in reference pages #1285

Closed
Tracked by #812
StackScribe opened this issue Apr 26, 2023 · 1 comment
Closed
Tracked by #812

Define how we handle apiVersion info in reference pages #1285

StackScribe opened this issue Apr 26, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation stale

Comments

@StackScribe
Copy link
Contributor

Part of #812

  • The auto-generated API docs have precise and accurate info about API versions but do not provide direct, user-friendly information about how to populate the yaml file that users must create
  • The authored YAML CRD files need to provide specific information about apiVersions. In addition to the "Differences between versions" information, how do we represent the apiVersion info in the "YAML synopsis" and "Field description" blocks so it is meaningful to the users without creating a maintenance headache. Perhaps we could implement some sort of variable that always renders as the latest version of the API?
  • Some manual effort is always required when publishing docs for a new release. If we provide complete information in the reference page, we can minimize the amount of this information that is included in the rest of the documentation
@StackScribe StackScribe added the documentation Improvements or additions to documentation label Apr 26, 2023
@github-actions
Copy link
Contributor

This issue has been automatically marked as stale because it has not had recent activity. It will be
closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale label Jun 27, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation stale
Projects
None yet
Development

No branches or pull requests

1 participant