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

Migrate chart documentation to helm-docs #315

Open
ccremer opened this issue Jun 7, 2021 · 0 comments
Open

Migrate chart documentation to helm-docs #315

ccremer opened this issue Jun 7, 2021 · 0 comments

Comments

@ccremer
Copy link
Contributor

ccremer commented Jun 7, 2021

https://github.com/norwoodj/helm-docs addresses an issue long present in helm charts:

There is often documentation and comments in values.yaml, and there is documentation in README.md.
There isn't a clear source of truth, as with manually maintained README it can get out-of-date pretty soon.

helm-docs follows the approach where the README is entirely generated from Chart metadata and values.yaml. however, it requires that comments in the yaml file follow a certain style in order to be properly parsed.

This issue aims to migrate the charts to make them "helm-docs-compatible" i.e. generate nicer READMEs.

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