Use of Automatic Helm Docs Generator
Closed this issue · 6 comments
Something trivial but easy and effective. Have used helm-docs before to automatically generate the Helm documentation based on comments. Worth adding?
As currently, your values file already includes @Section, @Param annotations, can you tell us if you use a tool to populate the tables containing the parameters of the README.md markdown file ? Which one ?
As currently, your values file already includes @section, @param annotations, can you tell us if you use a tool to populate the tables containing the parameters of the README.md markdown file ? Which one ?
yeah they annotations are there because I was thinking about using readme-generator-for-helm but I haven't set up yet. So, right now the documentation isn’t automatically generated.
Does anyone have more hands on experience on the pros and cons of both tools?
helm-docs is a super powerful tool but it lacks the feature to aggregate values/parameters (= a table) under different sections : norwoodj/helm-docs#97
Se we cannot currently generate something like this
## Section 1
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| containerPort | int | `8080` | blablabla |
Which ever one is best is good for me. I only said helm-docs as I've used it on another Chart. This issue was moreso around getting automatic documentation generation as opposed to using helm-docs. In fact, I shall change the title to be a bit more generic.
This issue was moreso around getting automatic documentation generation as opposed to using
helm-docs
Could we add this process generating the doc part of the github action - helm release or helm snapshot. WDYT ? @vinzscam