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>

Author: 3 people

Makefile

@@ -7,8 +7,8 @@ build:
 
 .PHONY: clean
 clean:
-	rm -r build
+	rm -rf build
 	# 'cache' is the configured cache dir in the playbook
-	rm -r cache
+	rm -rf cache
 
 .PHONY: build

antora-playbook.yml

@@ -19,11 +19,12 @@ content:
       branches:
         - HEAD
         - 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
@@ -32,19 +33,11 @@ content:
       branches:
         - main
         - 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.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:
@@ -56,123 +49,61 @@ content:
       branches:
         - main
         - 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.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.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.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.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.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.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.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.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.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.1
-        - distributed-component-compat
-      tags:
-        - docs/0.8
-        - docs/0.7
-        - docs/0.6
-        - docs/0.5
-        - docs/0.4
-        - docs/0.3
-        - docs/0.2
     - url: https://github.com/stackabletech/zookeeper-operator.git
       start_path: docs
       branches:
         - main
         - release-23.1
-        - distributed-component-compat
-        - old-release-docs/0.12
-        - old-release-docs/0.11
-        - old-release-docs/0.10
 
 ui:
   bundle:

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

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

local-antora-playbook.yml

@@ -15,35 +15,30 @@ urls:
 content:
   sources:
     - url: ./
-      branches: 
+      branches:
         - HEAD
         - 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.1
     # internal operators
     - url: https://github.com/stackabletech/commons-operator.git
       start_path: docs
       branches:
         - main
         - 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.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:
@@ -55,123 +50,61 @@ content:
       branches:
         - main
         - 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.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.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.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.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.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.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.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.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.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.1
-        - distributed-component-compat
-      tags:
-        - docs/0.8
-        - docs/0.7
-        - docs/0.6
-        - docs/0.5
-        - docs/0.4
-        - docs/0.3
-        - docs/0.2
     - url: https://github.com/stackabletech/zookeeper-operator.git
       start_path: docs
       branches:
         - main
         - release-23.1
-        - distributed-component-compat
-        - old-release-docs/0.12
-        - old-release-docs/0.11
-        - old-release-docs/0.10
 
 ui:
   bundle:

modules/ROOT/pages/getting_started.adoc

@@ -6,7 +6,7 @@ One of the best ways of getting started with a new platform is to try it out. An
 
 Firstly, let’s cover whether this *Getting Started* guide is right for you. This is intended as a learning tool to discover more about Stackable, its deployment and architecture.
 
-* If you want to build a production cluster then this is not for you. This tutorial is to familiarise you with the Stackable architecture and is not a guide for building robust clusters.
+* If you want to build a production cluster then this is not for you. This tutorial is to familiarize you with the Stackable architecture and is not a guide for building robust clusters.
 * This is intended for use in a private network or lab; it doesn't enable many security features such as authentication or encryption and should not be directly connected to the Internet. Be careful if you're deploying in the cloud as your instances may default to using public IPs.
 
 == Overview
@@ -76,7 +76,7 @@ Metrics-server is running at https://127.0.0.1:6443/api/v1/namespaces/kube-syste
 == Installing Stackable
 === Install stackablectl
 
-Install the Stackable command line utility xref:stackablectl::index.adoc[stackablectl] by following the installation steps for your platform on the xref:stackablectl::installation.adoc[installation] page.
+Install the Stackable command line utility xref:management:stackablectl:index.adoc[stackablectl] by following the installation steps for your platform on the xref:management:stackablectl:installation.adoc[installation] page.
 
 === Installing Stackable Operators
 The Stackable operators are components that translate the service definitions deployed via Kubernetes into deploy services on the worker nodes. These can be installed on any node that has access to the Kubernetes control plane. In this example we will install them on the controller node.