From 993cc20aa771222e0d12b7325d4e984dd241e300 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 22 Oct 2026 12:16:34 +0200 Subject: [PATCH] chore: Retire the crds.stackable.tech attributes --- antora.yml | 9 +-------- modules/ROOT/partials/operator-link-bar.adoc | 2 +- scripts/make-release-branch.sh | 3 --- supplemental-ui/partials/navbar.hbs | 3 ++- 4 files changed, 4 insertions(+), 13 deletions(-) diff --git a/antora.yml b/antora.yml index b7f6dee3a..d76965c2a 100644 --- a/antora.yml +++ b/antora.yml @@ -20,10 +20,6 @@ prerelease: true # https://docs.antora.org/antora/latest/component-attributes/#hard-set asciidoc: attributes: - # Keep this version in line with the 'version' key above - # The versions for the CRD docs are either 'nightly' or - # a full major.minor.patch version like 23.7.1 - crd-docs-version: "nightly" # Whether this version is already end of life. # If true, a banner will be displayed informing the user. end-of-life: false @@ -33,13 +29,10 @@ asciidoc: # Keep this in line with the 'version' key above: '?release=dev' on main, # '?release=' on release branches (the release script sets it). crd-ref-release: "?release=dev" - # DEPRECATED: the old CRD browser attributes below are still used by the - # operator docs; they migrate to crd-ref repo by repo (operator sweep). - crd-docs-base-url: "https://crds.stackable.tech" # used by the operator index pages, see the # operator-link-bar.adoc partial in the ROOT module hub-base-url: "https://hub.stackable.tech" - crd-docs: "{crd-docs-base-url}/{crd-docs-version}" # to make attributes accessible to the UI template, they need to # be prefixed with "page-" page-end-of-life: "{end-of-life}" + page-crd-ref: "{crd-ref}{crd-ref-release}" diff --git a/modules/ROOT/partials/operator-link-bar.adoc b/modules/ROOT/partials/operator-link-bar.adoc index ea16a26bd..ab3ccccd0 100644 --- a/modules/ROOT/partials/operator-link-bar.adoc +++ b/modules/ROOT/partials/operator-link-bar.adoc @@ -3,7 +3,7 @@ // Usage in an operator's index.adoc: // // :github: https://github.com/stackabletech/airflow-operator/ -// :crd: {crd-docs-base-url}/airflow-operator/{crd-docs-version}/ +// :crd: {crd-ref}{crd-ref-release}&operator=airflow-operator // :hub: {hub-base-url}/components/airflow // // include::ROOT:partial$operator-link-bar.adoc[] diff --git a/scripts/make-release-branch.sh b/scripts/make-release-branch.sh index 29956803d..e1b71bb39 100755 --- a/scripts/make-release-branch.sh +++ b/scripts/make-release-branch.sh @@ -117,9 +117,6 @@ sed -i "s/^version:.*/version: \"$DOCS_VERSION\"/" "$ANTORA_YAML_FILE" # Set prerelease to false sed -i "s/^prerelease:.*/prerelease: false/" "$ANTORA_YAML_FILE" -# Set crd-docs-version key to the 'version' variable -sed -i "s/^\(\s*\)crd-docs-version:.*/\1crd-docs-version: \"$VERSION\"/" "$ANTORA_YAML_FILE" - # Set the Hub release for the CRD reference links. The Hub names releases # by major.minor, so this uses DOCS_VERSION, not VERSION. sed -i "s/^\(\s*\)crd-ref-release:.*/\1crd-ref-release: \"?release=$DOCS_VERSION\"/" "$ANTORA_YAML_FILE" diff --git a/supplemental-ui/partials/navbar.hbs b/supplemental-ui/partials/navbar.hbs index 052cf4517..c2de39c34 100644 --- a/supplemental-ui/partials/navbar.hbs +++ b/supplemental-ui/partials/navbar.hbs @@ -17,7 +17,8 @@ {{#if (or (eq page.version "23.1") (eq page.version "23.4") (eq page.version "23.7") (eq page.version "23.11"))}} CRD Reference {{else}} - + {{!-- The UI serves every docs version: 24.3 to 25.11 only define crd-docs. --}} + CRD Reference {{/if}}