Added helm-docs for generating chart parameters documentation #67
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
Author
|
Just bumped chart version to |
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.
What kind of change does this PR introduce?
feature/ docs update
What is the current behavior?
Currently, users had to navigate through the
values.yamlfile to locate Chart parameters.This PR helps address the issue raised here #3.
What is the new behavior?
With this update, the Chart parameters documentation is now available in
README.md.A
helm-docstemplate (README.md.gotmpl), has been added for generating theREADMEfromvalues.yaml.Additional context
The comments in
values.yamlhave been updated to use thehelm-docssyntax.To sync
values.yamlwithREADME.md, execute the following command:To make changes to the base
README, modifications should be made toREADME.md.gotmpl.A live example of the updated
READMEis available here