You may have noticed that all our hooks provide a
README.md as well as a
The reason for this is that we want to provide the documentation of our Helm values directly in our
To avoid the need to do this task manually we use a tool that creates a table with all our values directly from our
Therefore there is no need to make any changes on the
README.md it self.
Every change has to be made in the
README.md.gotmpl should contain basic information about your hook like its purpose, how it is deployed, how it is configured as well as its Chart configurations generated out of the
For example the
README.md.gotmpl for WPScan looks like this:
If you want to generate the
README.md out of your
README.md.gotmpl locally, you can use
helm-docs (see: https://github.com/norwoodj/helm-docs/).