mercedes-benz / sechub

SecHub provides a central API to test software with different security tools.
https://mercedes-benz.github.io/sechub/
MIT License
259 stars 58 forks source link

Generate Helm Doc with helm-docs #3232

Open hamidonos opened 1 week ago

hamidonos commented 1 week ago

We should auto-generate a README.md by using helm-docs.

helm-docs is a tool for automatically generating markdown documentation for Helm charts. It works by reading the Chart.yaml and values.yaml files in a Helm chart directory and generating a README.md file.
The generated README.md file is written to the chart directory, replacing any existing README.md file.
To use helm-docs, you would typically install it on your local machine, navigate to your Helm chart directory, and then run the helm-docs command. This will generate a README.md file in the same directory as your Helm chart.