Skip to content
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

Open
colearendt opened this issue Jun 17, 2022 · 1 comment
Open

Automate generation of README values documentation #81

colearendt opened this issue Jun 17, 2022 · 1 comment

Comments

@colearendt
Copy link
Contributor

Is your feature request related to a problem? Please describe.
As discussed in #80 , keeping values.yaml in sync with README.md can be tricky. As a result, a tool called helm-docs has been developed that uses go-templating to auto-generate the README.md

Describe the solution you'd like
Use GitHub Actions / CI to auto-generate helm-docs output / keep the README.md documentation up to date with values.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 nice
    • Unfortunately, if this is desirable, the workaround is a little gross in the short term. I am happy to PR for review based on preference of output
    • An example display of "all values in a big table together" is here
  • Currently the documentation in README.md is quite concise (i.e. one sentence) and docs in values.yaml are quite thorough. If auto-generating, is it OK for README.md to become more verbose in line with values.yaml?
@colearendt colearendt mentioned this issue Jun 17, 2022
4 tasks
@colearendt
Copy link
Contributor Author

Added #82 for discussion on the implementation path

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant