fix(docs): filter Optional markers from validation column #723
Conversation
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
dosubot
bot
added
size:XS
The crd-ref-docs tool automatically recognizes the +optional marker
comments in Go code and renders them as validation entries. A recent
upstream change in github.com/elastic/crd-ref-docs master branch
started rendering these as `Optional: {}` text in the validation
column, which looks like an empty JSON object and is redundant since
the Required column already shows this information.
Update the documentation template to filter out these Optional markers
while preserving meaningful validation rules like patterns and enums.
Also remove the now-redundant customMarkers configuration, as the
current version of crd-ref-docs recognizes the optional marker without
explicit configuration.
Closes #722
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
Member
Author
|
Closing in favor of PR #724 which addresses the root cause by pinning crd-ref-docs to v0.2.0 instead of working around the issue with template filters. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The crd-ref-docs tool automatically recognizes the
+optionalmarker comments in Go code and renders them as validation entries. A recent upstream change in github.com/elastic/crd-ref-docs master branch started rendering these asOptional: {}text in the validation column, which looks like an empty JSON object and is redundant since the Required column already shows this information.This PR updates the documentation template to filter out these Optional markers while preserving meaningful validation rules like patterns and enums. Also removes the now-redundant customMarkers configuration, as the current version of crd-ref-docs recognizes the optional marker without explicit configuration.
Closes #722