-
Notifications
You must be signed in to change notification settings - Fork 4k
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
VPA: Generate API docs #7608
base: master
Are you sure you want to change the base?
VPA: Generate API docs #7608
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: adrianmoisey The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one comment. otherwise looks good to me
Package v1 contains definitions of Vertical Pod Autoscaler related objects. | ||
|
||
Package v1 contains definitions of Vertical Pod Autoscaler related objects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we do something about those duplicated lines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first one comes from here:
// Package v1 contains definitions of Vertical Pod Autoscaler related objects. |
The second one comes from here:
// Package v1 contains definitions of Vertical Pod Autoscaler related objects. |
Looking at other projects and their docs, I think it's fine to remove the comment from types.go, what do you think?
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Adds a script to generate API docs using crd-ref-docs
I did try use gen-crd-api-reference-docs to generate docs, but I struggled to get the templating working nicely with markdown, so I switched to crd-ref-docs.
The ordering of gen-crd-api-reference-docs is nicer, and I'd like to use it, but gave up after some time.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: