apache / couchdb-helm

Apache CouchDB Helm Chart
https://couchdb.apache.org/
Apache License 2.0
49 stars 64 forks source link

Automate generation of README values documentation #81

Open colearendt opened 2 years ago

colearendt commented 2 years ago

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:

colearendt commented 2 years ago

Added #82 for discussion on the implementation path