Most of the chart properties are missing documentation around what they do. helm-docs provides an easy mechanism to document this using # -- tags in the values.yaml file. Update the Docs, adding descriptions to properties and provide a short getting started blurb.
Ideally should use the README.md.gotmpl to template the README with relevant information and allow for lint automation.
Most of the chart properties are missing documentation around what they do.
helm-docsprovides an easy mechanism to document this using# --tags in thevalues.yamlfile. Update the Docs, adding descriptions to properties and provide a short getting started blurb.Ideally should use the
README.md.gotmplto template the README with relevant information and allow for lint automation.