Split CRD documentation into separate files #3696
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
The CRD API doc became unmanagably large with the addition of TargetAllocators, and can't even be rendered by Github's markdown viewer . Split it into separate files per CRD.
iblancasa
approved these changes
Feb 6, 2025
ElfoLiNk
pushed a commit
to ElfoLiNk/opentelemetry-operator
that referenced
this pull request
Feb 17, 2025
The CRD API doc became unmanagably large with the addition of TargetAllocators, and can't even be rendered by Github's markdown viewer . Split it into separate files per CRD.
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.
Description:
The CRD API doc became unmanagably large with the addition of TargetAllocators, and can't even be rendered by Github's markdown viewer. Split it into separate files per CRD.
The shell code to produce this is a bit hacky, but I'd like to merge it to resolve the problem first, and refine it a bit later.
Link to tracking Issue(s):