Closed zeljkobekcic closed 6 months ago
The Helm Chart directory should have a README.md describing the parameters and such. This README.md can be generated from the values.yaml file.
Take for example this values.yaml from the iits charts repository: https://github.com/iits-consulting/charts/blob/main/charts/iits-kyverno-policies/values.yaml
The Github Workflow from the iits charts is a good starting point: https://github.com/iits-consulting/charts/blob/main/.github/workflows/update_documentation.yaml
The usage of helm-docs seems very good.
helm-docs
The Helm Chart directory should have a README.md describing the parameters and such. This README.md can be generated from the values.yaml file.
Take for example this values.yaml from the iits charts repository: https://github.com/iits-consulting/charts/blob/main/charts/iits-kyverno-policies/values.yaml
The Github Workflow from the iits charts is a good starting point: https://github.com/iits-consulting/charts/blob/main/.github/workflows/update_documentation.yaml
The usage of
helm-docsseems very good.