Align docs structure with other controllers

In some controller we already support multiple API versions at the
same time. In order to streamline the docs structure, the necessary
changes to do the same in this repo are applied here as well.

refs fluxcd/website#1577

Signed-off-by: Max Jonas Werner <mail@makk.es>
This commit is contained in:
Max Jonas Werner 2023-07-20 18:44:23 +02:00
parent dbc98e9509
commit 726edec9a6
No known key found for this signature in database
GPG Key ID: EB525E0F02B52140
4 changed files with 10 additions and 3 deletions

View File

@ -81,7 +81,7 @@ manifests: controller-gen
# Generate API reference documentation
api-docs: gen-crd-api-reference-docs
$(GEN_CRD_API_REFERENCE_DOCS) -api-dir=./api/v2beta1 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api/helmrelease.md
$(GEN_CRD_API_REFERENCE_DOCS) -api-dir=./api/v2beta1 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api/v2beta1/helm.md
# Run go mod tidy
tidy:

View File

@ -1,4 +1,4 @@
<h1>HelmRelease API reference</h1>
<h1>Helm API reference v2beta1</h1>
<p>Packages:</p>
<ul class="simple">
<li>

View File

@ -1,5 +1,7 @@
# Helm Releases
<!-- menuweight:20 -->
The `HelmRelease` API defines a resource for automated controller driven Helm releases.
## Specification

View File

@ -1,5 +1,10 @@
{{ define "packages" }}
<h1>HelmRelease API reference</h1>
<h1>Helm API reference
{{- with (index .packages 0) -}}
{{ with (index .GoPackages 0 ) -}}
{{ printf " %s" .Name -}}
{{ end -}}
{{ end }}</h1>
{{ with .packages}}
<p>Packages:</p>