Expand best practices around documenting values.yaml #1475
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: Matt Carr <mcarr@kinaxis.com>
matt-carr
commented
Jun 7, 2023
|
|
||
| ### Nested Properties: | ||
|
|
||
| When documenting nested properties, use the "fully qualified" name of the property |
There was a problem hiding this comment.
"fully qualified" isn't great but I couldn't think of a better descriptor at the time. Maybe
Suggested change
| When documenting nested properties, use the "fully qualified" name of the property | |
| When documenting nested properties, use the complete path of the property |
?
|
~bump~ |
|
🙃 bump 🙂 |
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.
Followup from helm/helm#11787
My team went through a very long exercise of updating our values.yaml documentation and weren't sure what the best practices around nested values and subcharts were. These are our suggestions, based on what seemed to make sense at the time - naturally, open to suggestions, and even to ditch this whole thing in favour of a single line "use your best judgement with nested properties".
The intent is to match up as much as possible with the best practices laid out earlier - specifically, easily grep-able names