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

docs/*/api-types should be generated #8462

Open
kaovilai opened this issue Nov 26, 2024 · 0 comments
Open

docs/*/api-types should be generated #8462

kaovilai opened this issue Nov 26, 2024 · 0 comments

Comments

@kaovilai
Copy link
Member

Describe the problem/challenge you have

Our API Types documentation are manually updated. We should generate them when updating CRD.

ie. https://velero.io/docs/main/api-types/ , https://velero.io/docs/v1.15/api-types/

Describe the solution you'd like

Use https://github.com/ahmetb/gen-crd-api-reference-docs and the likes to update docs when CRD change is detected.
Add to make target for crd.
Add GH Actions to check crd docs in PR is up to date.

Anything else you would like to add:

Environment:

  • Velero version (use velero version):
  • Kubernetes version (use kubectl version):
  • Kubernetes installer & version:
  • Cloud provider or hardware configuration:
  • OS (e.g. from /etc/os-release):

Vote on this issue!

This is an invitation to the Velero community to vote on issues, you can see the project's top voted issues listed here.
Use the "reaction smiley face" up to the right of this comment to vote.

  • 👍 for "The project would be better with this feature added"
  • 👎 for "This feature will not enhance the project in a meaningful way"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant