GA: adapt to n-c Receiver API graduating to v1

With fluxcd/notification-controller#498 we're graduating the Receiver API group version to v1 and keeping all other kinds' version at v1beta2. Therefore we need to publish API docs for both version. In addition to that we want the API navigation entry to appear at the bottom of the tree. To accomplish that the import script is now able to parse a weight parameter from imported markdown specs and put it into the front matter of the resulting file. refs fluxcd/notification-controller#436 Signed-off-by: Max Jonas Werner <[email protected]>
fluxcd · Mar 23, 2023 · 818be4e · 818be4e
1 parent e4abe38
commit 818be4e
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/content/en/flux/components/notification/.gitignore b/content/en/flux/components/notification/.gitignore
@@ -1,5 +1,5 @@
 alert.md
-api.md
+api/v*.md
 event.md
 provider.md
 receiver.md
diff --git a/content/en/flux/components/notification/api/.gitkeep b/content/en/flux/components/notification/api/.gitkeep
diff --git a/content/en/flux/components/notification/api/_index.md b/content/en/flux/components/notification/api/_index.md
@@ -0,0 +1,5 @@
+---
+title: API Reference
+linkTitle: API Reference
+weight: 1000
+---
diff --git a/content/en/flux/components/notification/options.md b/content/en/flux/components/notification/options.md
@@ -2,7 +2,7 @@
 title: Controller Options
 linkTitle: Controller Options
 description: "Controller command flags and defaults."
-weight: 1000
+weight: 1
 ---
 
 To customise the controller options at install time,

diff --git a/hack/import-flux2-assets.sh b/hack/import-flux2-assets.sh
@@ -94,6 +94,11 @@ gen_crd_doc() {
  exit 1
  fi
 
+ WEIGHT="$(grep -E '^<!-- menuweight:[[:digit:]]+ -->$' "$TMP" | cut -d' ' -f2|cut -d':' -f2)"
+ if [ -z "${WEIGHT}" ] ; then
+ WEIGHT=0
+ fi
+
  if [ -n "$TITLE" ]; then
  {
  echo "---"
@@ -103,6 +108,7 @@ gen_crd_doc() {
  if [ -n "$HUGETABLE" ]; then
  echo "hugeTable: true"
  fi
+ echo "weight: $WEIGHT"
  echo "---"
  } >> "$DEST"
  grep -vE "^<!--" "$TMP" |sed '1d' >> "$DEST"
@@ -140,8 +146,9 @@ gen_crd_doc() {
 
 {
  # notification-controller CRDs
- NOTIFICATION_VER="$(controller_version notification-controller)"
- gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/api/notification.md" "$COMPONENTS_DIR/notification/api.md"
+ NOTIFICATION_VER="receiver-v1"
+ gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/api/v1/notification.md" "$COMPONENTS_DIR/notification/api/v1.md"
+ gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/api/v1beta2/notification.md" "$COMPONENTS_DIR/notification/api/v1beta2.md"
  gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta2/events.md" "$COMPONENTS_DIR/notification/event.md"
  gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta2/alerts.md" "$COMPONENTS_DIR/notification/alert.md"
  gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta2/providers.md" "$COMPONENTS_DIR/notification/provider.md"