Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: home

Check warning on line 1 in antora.yml

View workflow job for this annotation

GitHub Actions / prek

1:1 [document-start] missing document start "---"
version: "nightly"
title: Stackable Documentation
nav:
Expand All @@ -20,10 +20,6 @@
# 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
Expand All @@ -33,13 +29,10 @@
# Keep this in line with the 'version' key above: '?release=dev' on main,
# '?release=<major.minor>' 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}"
2 changes: 1 addition & 1 deletion modules/ROOT/partials/operator-link-bar.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
3 changes: 0 additions & 3 deletions scripts/make-release-branch.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
3 changes: 2 additions & 1 deletion supplemental-ui/partials/navbar.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -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"))}}
<a class="navbar-item" href="{{{ relativize (versioned "home" page "reference/index.html") }}}">CRD Reference</a>
{{else}}
<a class="navbar-item" href="{{{ page.attributes.crd-docs }}}" target="_blank">
{{!-- The UI serves every docs version: 24.3 to 25.11 only define crd-docs. --}}
<a class="navbar-item" href="{{{ or page.attributes.crd-ref page.attributes.crd-docs }}}" target="_blank">
CRD Reference <svg class="svg-icon" style="width: 0.875em; height: 0.875em; margin-left: 5px;" aria-hidden="true"><use href="#icon-external-link"/></svg>
</a>
{{/if}}
Expand Down
Loading