📖 Organize generated CRD documentation by API group #3110
Merged
Conversation
This file contains 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
Signed-off-by: Marvin Beckers <[email protected]>
kcp-ci-bot
added
release-note-none
|
/lgtm |
|
LGTM label has been added. Git tree hash: 9ab45d7c7240f9427135820c97e1f5a56bdb177a
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sttts 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 |
kcp-ci-bot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The generated CRD documentation is a flat list, which includes all kcp APIs. This PR post-processes the output of https://github.com/giantswarm/crd-docs-generator (I couldn't find an option to split by API group; might be worth upstreaming such a change) and puts each API group in its own folder, providing a more organised CRD documentaiton experience:
Related issue(s)
Fixes #
Release Notes