Add CRD pattern docs for each group #3147
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
theunrepentantgeek
requested review from
davefellows,
matthchr,
babbageclunk and
super-harsh
as code owners
theunrepentantgeek
force-pushed
the
feature/crd-pattern-docs
branch
from
2e48fb7 to
2900354
Compare
theunrepentantgeek
changed the title
super-harsh
approved these changes
Jul 19, 2023
There was a problem hiding this comment.
LGTM! Although, I'm not sure how many users would know where to find this pattern during installation. A suggestion is to add a Note on crd management doc page on how and where to find the group pattern.
|
I hope that users will spot the additional docs as they skim the list of supported resources, and then they'll know to loop back and update their installation. Adding more information to the CRD management page is also a good idea, I'll add that to my list. |
theunrepentantgeek
force-pushed
the
feature/crd-pattern-docs
branch
from
2900354 to
8899ac5
Compare
Codecov Report
@@ Coverage Diff @@
## main #3147 +/- ##
=======================================
Coverage 54.19% 54.19%
=======================================
Files 1419 1419
Lines 608072 608092 +20
=======================================
+ Hits 329522 329554 +32
+ Misses 224549 224546 -3
+ Partials 54001 53992 -9
|
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.
What this PR does / why we need it:
Adds detail for each group identifying the CRD pattern parameter required for installation of those resources.
Partially addresses #3142
Special notes for your reviewer:
Implemented by adding a new documentation fragment to show for each group, and by modifying the handling for all fragments to treat them as templates, allowing substitution of values.
How does this PR make you feel:
If applicable: