From 3420fc7d349564042e657825297ce108f71e75e6 Mon Sep 17 00:00:00 2001 From: Johannes Fleck Date: Mon, 2 Nov 2026 11:41:57 +0100 Subject: [PATCH] docs: Add the Cockpit docs Cockpit's docs are the 'cockpit' module of the 'home' component and are versioned with the SDP like the operator docs. Cockpit is linked under Tools in the navbar and has its own entry in the sidebar. --- antora-playbook.yml | 5 +++++ local-antora-playbook.yml | 5 +++++ modules/ROOT/nav2.adoc | 5 +++++ only-dev-antora-playbook.yml | 5 +++++ scripts/publish-new-version.sh | 4 ++-- supplemental-ui/partials/navbar.hbs | 16 ++++++++++++++++ truly-local-playbook.yml | 3 +++ 7 files changed, 41 insertions(+), 2 deletions(-) diff --git a/antora-playbook.yml b/antora-playbook.yml index 8fc6cefdc..c334a9586 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -51,6 +51,11 @@ content: - url: https://github.com/stackabletech/stackablectl.git start_path: docs branches: main + # web UI + - url: https://github.com/stackabletech/cockpit.git + start_path: docs + branches: + - main # demos - url: https://github.com/stackabletech/demos.git start_path: docs diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 1469b3fd9..4a4bd63fc 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -36,6 +36,11 @@ content: - url: https://github.com/stackabletech/stackablectl.git start_path: docs branches: main + # web UI + - url: https://github.com/stackabletech/cockpit.git + start_path: docs + branches: + - main # demos - url: https://github.com/stackabletech/demos.git start_path: docs diff --git a/modules/ROOT/nav2.adoc b/modules/ROOT/nav2.adoc index 793a38ab6..d2fd8cb52 100644 --- a/modules/ROOT/nav2.adoc +++ b/modules/ROOT/nav2.adoc @@ -1,2 +1,7 @@ * Management ** xref:management:stackablectl:index.adoc[] +* xref:cockpit:index.adoc[Cockpit] ++ +-- +include::cockpit:partial$nav.adoc[] +-- diff --git a/only-dev-antora-playbook.yml b/only-dev-antora-playbook.yml index 14f5e6813..5a6ccad75 100644 --- a/only-dev-antora-playbook.yml +++ b/only-dev-antora-playbook.yml @@ -24,6 +24,11 @@ content: - url: https://github.com/stackabletech/stackablectl.git start_path: docs branches: main + # web UI + - url: https://github.com/stackabletech/cockpit.git + start_path: docs + branches: + - main # demos - url: https://github.com/stackabletech/demos.git start_path: docs diff --git a/scripts/publish-new-version.sh b/scripts/publish-new-version.sh index 98c72bb5d..d8b8ae510 100755 --- a/scripts/publish-new-version.sh +++ b/scripts/publish-new-version.sh @@ -65,14 +65,14 @@ if ! git rev-parse --quiet --verify "$BRANCH" > /dev/null; then fi echo "Did you create all the release branches in the operators?" -echo "Did you also create a release branch in the demos repository?" +echo "Did you also create release branches in the cockpit and demos repositories?" read -r -p "(yes/no): " OPERATORS_BRANCHES_ANSWER # Convert the user input to lowercase for case-insensitive comparison OPERATORS_BRANCHES_ANSWER_LOWERCASE=$(echo "$OPERATORS_BRANCHES_ANSWER" | tr '[:upper:]' '[:lower:]') if [ "$OPERATORS_BRANCHES_ANSWER_LOWERCASE" != "yes" ]; then - echo "Please create all the branches in the operators before proceeding." + echo "Please create all the branches in the operators, cockpit and demos before proceeding." exit 1 fi diff --git a/supplemental-ui/partials/navbar.hbs b/supplemental-ui/partials/navbar.hbs index c2de39c34..479865e18 100644 --- a/supplemental-ui/partials/navbar.hbs +++ b/supplemental-ui/partials/navbar.hbs @@ -66,6 +66,22 @@ Tools
stackablectl + {{#if (not (or + (eq page.version "23.1") + (eq page.version "23.4") + (eq page.version "23.7") + (eq page.version "23.11") + (eq page.version "24.3") + (eq page.version "24.7") + (eq page.version "24.11") + (eq page.version "25.3") + (eq page.version "25.7") + (eq page.version "25.11") + (eq page.version "26.3") + (eq page.version "26.7") + ))}} + Cockpit + {{/if}}
diff --git a/truly-local-playbook.yml b/truly-local-playbook.yml index 220fd3512..bf56bcbf1 100644 --- a/truly-local-playbook.yml +++ b/truly-local-playbook.yml @@ -23,6 +23,9 @@ content: # management tools - url: ../stackablectl/ start_path: docs + # web UI + - url: ../cockpit/ + start_path: docs # demos - url: ../demos/ start_path: docs