Merge branch 'main' of https://github.com/stackabletech/documentation into feat/add-airgap-documentation

Author: dervoeti

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
         with:
           submodules: true
           fetch-depth: 0
-      - uses: actions/setup-node@e33196f7422957bea03ed53f6fbb155025ffc7b8 # v3
+      - uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3
         with:
           node-version: '16'
           cache: 'npm'

.github/workflows/deploy.yml

@@ -6,7 +6,8 @@ name: Build and deploy production site
 
 on:
   schedule:
-    - cron: '15 2 * * *'
+    # Monday to Friday, 2:15 in the night
+    - cron: '15 2 * * 1-5'
   workflow_dispatch:
 
 jobs:

Makefile

@@ -10,9 +10,9 @@ build-ui:
 	node_modules/.bin/gulp --cwd ui bundle
 
 clean:
-	rm -r build
+	rm -rf build
 	# 'cache' is the configured cache dir in the playbook
-	rm -r cache
+	rm -rf cache
 
 # The netlify repo is checked out without any blobs. This script
 # iterates through the release branches and checks them out one-by-one
@@ -27,7 +27,7 @@ netlify-fetch:
 	git fetch --all
 	# checkout all release branches once, so we fetch the files
 	for remote in $(shell git branch -r | grep release/); do \
-		git checkout --recurse-submodules "$${remote#origin/}" ;\
+		git checkout --recurse-submodules "$${remote#origin/}" ; git pull; \
 	done
 	# go back to the initial commit to start the build
 	git -c advice.detachedHead=false checkout --recurse-submodules $(CURRENT_COMMIT)

antora-playbook.yml

@@ -7,54 +7,66 @@ site:
   keys:
     enable_tracking: true
 
+# URL config settings.
+# docs: https://docs.antora.org/antora/latest/playbook/configure-urls/
 urls:
-  # This replaces the component version in the URL of the latest stable version with 'stable'
-  # i.e. /commons-operator/stable/index.html instead of /commons-operator/0.3/index.html
+  # The symbolic name of the latest stable version, and how to redirect from/to it.
+  # with 'redirect:to', the _actual_ version link is a redirect, and the _actual_ link 
+  # contains the symbolic name, i.e. stable.
+  # As the user browses the latest docs, there will be 'stable' in the links. Also 
+  # search engines will see the 'stable' link and index those pages, so if we release
+  # a new version, these links will be already in the index, which is good.
+  # Linking to the latest version by version number is still possible, and after the
+  # latest version is not latest anymore, the redirect is instead the actual URL.
   latest_version_segment: stable
+  latest_version_segment_strategy: redirect:to
+  # We deploy our site on netlify, so we use their redirect config mechanism
   redirect_facility: netlify
 
 content:
   sources: 
     - url: .
       branches:
         - HEAD
+        - release/23.11
         - release/23.7
         - release/23.4
         - release/23.1
-        - release/22.11
-        - release/22.09
-        - release/22.06
-    # stackablectl
-    - url: https://github.com/stackabletech/stackablectl.git
+    # management tools
+    - url: https://github.com/stackabletech/stackable-cockpit.git
       start_path: docs
       branches: main
+    # demos
+    - url: https://github.com/stackabletech/demos.git
+      start_path: docs
+      branches:
+        - main
+        - release-23.11
+        - release-23.7
+        - release-23.4
+        - release-23.1
     # internal operators
     - url: https://github.com/stackabletech/commons-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat  # (required for 0.4 and below)
-        - old-release-docs/0.4
-        - old-release-docs/0.3
-        - old-release-docs/0.2
     - url: https://github.com/stackabletech/secret-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat  # (required for 0.6 and below)
-      tags:
-        - docs/0.6
-        - docs/0.5
     - url: https://github.com/stackabletech/listener-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
@@ -63,146 +75,98 @@ content:
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat  # (required for 0.6 and below)
-        - old-release-docs/0.6
-        - old-release-docs/0.5
-      tags:
-        - docs/0.4
     - url: https://github.com/stackabletech/druid-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-        - old-release-docs/0.8
-        - old-release-docs/0.7
-      tags:
-        - docs/0.6
     - url: https://github.com/stackabletech/hbase-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-        - old-release-docs/0.5
-        - old-release-docs/0.4
-        - old-release-docs/0.3
     - url: https://github.com/stackabletech/hdfs-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-        - old-release-docs/0.6
-        - old-release-docs/0.5
-      tags:
-        - docs/0.4
     - url: https://github.com/stackabletech/hive-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-      tags:
-        - docs/0.8
-        - docs/0.7
-        - docs/0.6
     - url: https://github.com/stackabletech/kafka-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-      tags:
-        - docs/0.8
-        - docs/0.7
-        - docs/0.6
     - url: https://github.com/stackabletech/nifi-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat  # (required for 0.8 and below)
-        - old-release-docs/0.8
-        - old-release-docs/0.7
-        - old-release-docs/0.6
     - url: https://github.com/stackabletech/opa-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-      tags:
-        - docs/0.11
-        - docs/0.10
-        - docs/0.9
     - url: https://github.com/stackabletech/spark-k8s-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-      tags:
-        - docs/0.6
-        - docs/0.5
-        - docs/0.4
-        - docs/0.3
-        - docs/0.2
     - url: https://github.com/stackabletech/superset-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-        - old-release-docs/0.7
-        - old-release-docs/0.6
-        - old-release-docs/0.5
     - url: https://github.com/stackabletech/trino-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-        - old-release-docs/0.8
-        - old-release-docs/0.7
-      tags:
-        - docs/0.6
-        - docs/0.5
-        - docs/0.4
     - url: https://github.com/stackabletech/zookeeper-operator.git
       start_path: docs
       branches:
         - main
+        - release-23.11
         - release-23.7
         - release-23.4
         - release-23.1
-        - distributed-component-compat
-        - old-release-docs/0.12
-        - old-release-docs/0.11
-        - old-release-docs/0.10
 
 ui:
   bundle:
@@ -212,15 +176,14 @@ ui:
 antora:
   extensions:
     - '@antora/lunr-extension'
-    - asciidoctor-kroki
 
 asciidoc:
   attributes:
     base-repo: https://github.com/stackabletech
     plantuml-server-url: http://www.plantuml.com/plantuml
     kroki-fetch-diagram: true
-  extensions:
-    - asciidoctor-kroki
+    # an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
+    external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
 
 # the default caching directory is ./.cache/antora
 # Antora caches the git repos, this can sometimes lead to stale content

antora.yml

@@ -4,9 +4,26 @@ title: Stackable Documentation
 nav:
   - modules/ROOT/nav.adoc
   - modules/concepts/nav.adoc
+  - modules/demos/nav.adoc
   - modules/tutorials/nav.adoc
-  - modules/reference/nav.adoc
   - modules/operators/nav.adoc
+  - modules/reference/nav.adoc
   - modules/contributor/nav.adoc
   - modules/ROOT/nav2.adoc
+# The prerelease setting affects version sorting.
+# Set to 'true' for nightly and false otherwise.
 prerelease: true
+# The attributes below are specific to this component and version
+# 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"
+    # use the attributes below to link to the CRD docs
+    crd-docs-base-url: "https://crds.stackable.tech"
+    crd-docs: "{crd-docs-base-url}/{crd-docs-version}"
+    # this attribute is an annoying little hack to make the versioned
+    # link accessible to the UI template.
+    page-crd-docs: "{crd-docs}"