From 726edec9a62df77922835b21a9f40899dfb3a5a2 Mon Sep 17 00:00:00 2001
From: Max Jonas Werner <mail@makk.es>
Date: Thu, 20 Jul 2023 18:44:23 +0200
Subject: [PATCH] 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>
---
 Makefile                                     | 2 +-
 docs/api/{helmrelease.md => v2beta1/helm.md} | 2 +-
 docs/spec/v2beta1/helmreleases.md            | 2 ++
 hack/api-docs/template/pkg.tpl               | 7 ++++++-
 4 files changed, 10 insertions(+), 3 deletions(-)
 rename docs/api/{helmrelease.md => v2beta1/helm.md} (99%)

diff --git a/Makefile b/Makefile
index 5657712..ee5511a 100644
--- a/Makefile
+++ b/Makefile
@@ -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:
diff --git a/docs/api/helmrelease.md b/docs/api/v2beta1/helm.md
similarity index 99%
rename from docs/api/helmrelease.md
rename to docs/api/v2beta1/helm.md
index 3d02e4f..1079bdc 100644
--- a/docs/api/helmrelease.md
+++ b/docs/api/v2beta1/helm.md
@@ -1,4 +1,4 @@
-<h1>HelmRelease API reference</h1>
+<h1>Helm API reference v2beta1</h1>
 <p>Packages:</p>
 <ul class="simple">
 <li>
diff --git a/docs/spec/v2beta1/helmreleases.md b/docs/spec/v2beta1/helmreleases.md
index 0e72534..34881b0 100644
--- a/docs/spec/v2beta1/helmreleases.md
+++ b/docs/spec/v2beta1/helmreleases.md
@@ -1,5 +1,7 @@
 # Helm Releases
 
+<!-- menuweight:20 -->
+
 The `HelmRelease` API defines a resource for automated controller driven Helm releases.
 
 ## Specification
diff --git a/hack/api-docs/template/pkg.tpl b/hack/api-docs/template/pkg.tpl
index f5a6d35..be75352 100644
--- a/hack/api-docs/template/pkg.tpl
+++ b/hack/api-docs/template/pkg.tpl
@@ -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>