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

VPA: Generate API docs #7608

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

adrianmoisey
Copy link
Member

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.:


@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 15, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: adrianmoisey
Once this PR has been reviewed and has the lgtm label, please assign raywainman for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Member

@omerap12 omerap12 left a 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

Comment on lines +9 to +11
Package v1 contains definitions of Vertical Pod Autoscaler related objects.

Package v1 contains definitions of Vertical Pod Autoscaler related objects.
Copy link
Member

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?

Copy link
Member Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/vertical-pod-autoscaler cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants