mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-12 04:32:00 +01:00
18 lines
816 B
Markdown
18 lines
816 B
Markdown
|
 
|
||
|
|
|
||
|
|
A subchart stores victoriametrics operator CRDs.
|
||
|
|
|
||
|
|
## Documentation of Helm Chart
|
||
|
|
|
||
|
|
Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
|
||
|
|
|
||
|
|
Generate docs with ``helm-docs`` command.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd charts/crds
|
||
|
|
|
||
|
|
helm-docs
|
||
|
|
```
|
||
|
|
|
||
|
|
The markdown generation is entirely go template driven. The tool parses metadata from charts and generates a number of sub-templates that can be referenced in a template file (by default ``README.md.gotmpl``). If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.
|