helm-chart-docs-generator

README

helm-chart-docs-generator

Generates configuration template for Cluster App documentation.

This tool is built to generate our Cluster App configuration reference.

The generated output consists of Markdown files which includes automatically the content of the Helm chart READMEs.

Usage

Docker

The generator can be executed in Docker using a command like this:

docker run \
    -v $PWD/path/to/output-folder:/opt/helm-chart-docs-generator/output \
    -v $PWD:/opt/helm-chart-docs-generator/config \
    quay.io/giantswarm/helm-chart-docs-generator:0.1.0 \
      --config /opt/helm-chart-docs-generator/config/config.example.yaml

Here, the tag 0.1.0 is the version number of the helm-chart-docs-generator release you're going to use. Check the image repository for available tags.

The volume mapping defines where the generated output will land.

Development

With Go installed and this repository cloned, you can execute the program like this:

go run main.go --config config.example.yaml

See the config.example.yaml file for an idea of how to configure your source repositories.