Add helm-docs #82
Merged
Add helm-docs #82
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
This file will be used by `helm-docs` to generate the `README.md`. Also added the `--version` flag to helm invocations for user reproducibility
This brings in all documentation, but we can use `##` to hide extra verbosity from the README if desired
willholley
approved these changes
Dec 6, 2022
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:
This begins replacing the manual README.md generation with auto-generation using
helm-docs(as discussed in #81 ). This does not finish that issue, because it does not solve the CI problem (yet). This is meant for discussion abouthelm-docsitself and the implementation questions raised in #81README as generated on GitHub can be reviewed here: https://github.com/colearendt/couchdb-helm/tree/add-docs/couchdb
Which issue this PR fixes
None
Special notes for your reviewer:
Will require a chart version bump (changing README), so should not be merged until after #80
Checklist
[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.