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

Document root CRD objects as API resource types. #207

Merged
merged 1 commit into from
Jun 7, 2020

Conversation

jpeach
Copy link
Contributor

@jpeach jpeach commented Jun 4, 2020

When finding the set of root CRD types, the documentation
generator checks for the +genclient annotation, ratherd
than the newer +kubebuilder:object:root.

Adding +genclient makes the root CRD type objects appear in the
resource list at the head of the API documentation, which improves
their visibility.

Signed-off-by: James Peach jpeach@vmware.com

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 4, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @jpeach. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jpeach
Copy link
Contributor Author

jpeach commented Jun 4, 2020

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 4, 2020
When finding the set of root CRD types, the documentation
generator checks for the `+genclient` annotation, ratherd
than the newer `+kubebuilder:object:root`.

Adding `+genclient` makes the root CRD type objects appear in the
resource list at the head of the API documentation, which improves
their visibility.

Signed-off-by: James Peach <jpeach@vmware.com>
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 4, 2020
@jpeach
Copy link
Contributor Author

jpeach commented Jun 4, 2020

@robscott Can you PTAL at your leisure?

@robscott
Copy link
Member

robscott commented Jun 4, 2020

Thanks! This is a nice addition. For anyone curious, in addition to moving all the top level resources to the top, it adds some helpful top-level links to them.

Screen Shot 2020-06-03 at 10 40 50 PM

/ok-to-test
/lgtm

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 4, 2020
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 4, 2020
@bowei
Copy link
Contributor

bowei commented Jun 7, 2020

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bowei, jpeach

The full list of commands accepted by this bot can be found here.

The pull request process is described 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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 7, 2020
@k8s-ci-robot k8s-ci-robot merged commit df6e630 into kubernetes-sigs:master Jun 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants