docs: Add management and demo docs (#449)

* Add Management and Demo docs * Update xrefs and formatting * Fix xref * Update playbook * Update discussions link * Update Makefile * Fix most internal and external links * Update playbooks * Update top navigation * Add demo navigation * Update xref in release notes * Switch back to main branches in playbook * Fix branch name in playbook * Remove fixup branches from Hive repo * Apply suggestions Co-authored-by: Felix Hennig <fhennig@users.noreply.github.com> * Remove home component from xrefs --------- Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.de> Co-authored-by: Felix Hennig <fhennig@users.noreply.github.com>
stackabletech · Sep 22, 2023 · 6061833 · 6061833
1 parent ed66203
commit 6061833
Show file tree

Hide file tree

Showing 17 changed files with 466 additions and 358 deletions.
diff --git a/Makefile b/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

diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -21,11 +21,12 @@ content:
         - 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: docs/stackablectl
+    # demos
+    - url: https://github.com/stackabletech/demos.git
       start_path: docs
       branches: main
     # internal operators
@@ -36,21 +37,13 @@ content:
         - 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.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:
@@ -66,143 +59,83 @@ content:
         - 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.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.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.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.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.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.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.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.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.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.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.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:

diff --git a/antora.yml b/antora.yml
@@ -4,6 +4,7 @@ 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

diff --git a/gitpod-antora-playbook.yml b/gitpod-antora-playbook.yml
@@ -18,8 +18,11 @@ content:
     - url: /workspace/documentation
       tags: []
       branches: [HEAD, release/*]
-    # stackablectl
-    - url: https://github.com/stackabletech/stackablectl.git
+    # management tools
+    - url: https://github.com/stackabletech/stackable-cockpit.git
+      start_path: docs
+    # demos
+    - url: https://github.com/stackabletech/demos.git
       start_path: docs
     # internal operators
     - url: https://github.com/stackabletech/commons-operator.git