Improve API reference docs#667
Merged
openshift-merge-robot merged 1 commit intoopenshift:mainfrom Nov 10, 2021
Merged
Conversation
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ironcladlou The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
|
✔️ Deploy Preview for hypershift-docs ready! 🔨 Explore the source changes: 32f870e 🔍 Inspect the deploy log: https://app.netlify.com/sites/hypershift-docs/deploys/618c30cc2bf4b0000783f0ea 😎 Browse the preview: https://deploy-preview-667--hypershift-docs.netlify.app/reference/api |
This commit updates API documentation on the Go types and also improves the generated API documentation to include only the public types, as well as other minor small fixes for readability. Note that the `+gencopy` comments added to the API types are to work around an issue[1] in the upstream docs generation code which doesn't yet understand the `+kubebuilder:object:root` tag. This is necessary to make the generator understand which types are "public" (e.g. HostedCluster and NodePool). [1] ahmetb/gen-crd-api-reference-docs#26
ironcladlou
force-pushed
the
api-docs-updates
branch
from
0249915 to
32f870e
Compare
Contributor
|
/lgtm |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit updates API documentation on the Go types and also improves
the generated API documentation to include only the public types, as well
as other minor small fixes for readability.
Note that the
+gencopycomments added to the API types are to work aroundan issue[1] in the upstream docs generation code which doesn't yet understand
the
+kubebuilder:object:roottag. This is necessary to make the generatorunderstand which types are "public" (e.g. HostedCluster and NodePool).
[1] ahmetb/gen-crd-api-reference-docs#26