-
Notifications
You must be signed in to change notification settings - Fork 63
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Automate generation of README values documentation #81
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
As discussed in #80 , keeping
values.yaml
in sync withREADME.md
can be tricky. As a result, a tool calledhelm-docs
has been developed that uses go-templating to auto-generate the README.mdDescribe the solution you'd like
Use GitHub Actions / CI to auto-generate
helm-docs
output / keep the README.md documentation up to date withvalues.yaml
Describe alternatives you've considered
Manual maintenance as is currently done
Additional context
I have started on an implementation of this, which has generated some questions:
couchdb-helm
currently displays "selections" of values. i.e. "these values are for XYZ, these are for ABC". Is this desirable to maintain?helm-docs
does not currently support this idea, but I have created an issue to track doing so, because it seems niceREADME.md
is quite concise (i.e. one sentence) and docs invalues.yaml
are quite thorough. If auto-generating, is it OK for README.md to become more verbose in line withvalues.yaml
?The text was updated successfully, but these errors were encountered: