Documenting a Helm chart
As with any other software that users interact with, a Helm chart should be properly documented so that users know how to interact with it. The Helm chart structure supports a
README.md file for documenting usage, a
LICENSE file for covering usage and distribution rights, and a
templates/NOTES.txt file for generating usage instructions during chart installation.
The README.md File
- Prerequisites: A common example of a prerequisite is creating a
secretor a set of secrets to the Kubernetes cluster before a chart is installed. for the purpose of mounting to a Kubernetes deployment. Users can be made aware of this requirement by referencing the README file.
- Values: Charts often consist of many different values, each of which should be described in a table...