Add versioning to the main documentation

antora-playbook.yml

@@ -13,6 +13,7 @@ content:
   sources: 
     - url: https://github.com/stackabletech/documentation.git
       branches: main
+      tags: docs/*
 
     - url: https://github.com/stackabletech/stackablectl.git
       branches: main

antora.yml

@@ -1,5 +1,5 @@
 name: home
-version: master
+version: "nightly"
 title: Stackable Documentation
 nav:
   - modules/ROOT/nav.adoc
@@ -8,4 +8,5 @@ nav:
   - modules/reference/nav.adoc
   - modules/operators/nav.adoc
   - modules/contributor/nav.adoc
-  - modules/ROOT/nav2.adoc
+  - modules/ROOT/nav2.adoc
+prerelease: true

local-antora-playbook.yml

@@ -13,6 +13,7 @@ urls:
 content:
   sources: 
     - url: ./
+      tags: docs/*
       branches: HEAD
 
     - url: https://github.com/stackabletech/stackablectl.git

scripts/version_bump.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Creates two commits:
+# - the first commit with the new version and tagged
+# - the second commit bumped back to nightly
+
+if [ ! $# -eq 1 ]
+then
+  echo "Version required. I.e.: ./script.sh 22.06"
+  exit 1
+fi
+
+if [ ! -z "$(git status --porcelain)" ]; then 
+  echo "There are uncommitted changes, please resolve before running this script."
+  exit 1
+fi
+
+export new_version="$1"
+
+docs_dir="$(dirname "$0")/.."
+antora_file=$docs_dir/antora.yml
+
+branch_name="version-bump-$new_version"
+
+git checkout -b "$branch_name"
+
+
+echo "Updating $antora_file to version $new_version"
+yq eval --inplace '.version = strenv(new_version)' $antora_file
+yq eval --inplace '.prerelease = false' $antora_file
+
+echo "Committing ..."
+git add "$antora_file"
+git commit -m "Set version $new_version"
+git tag -a "docs/$new_version" -m "Documentation for release $new_version"
+
+echo "Updating $antora_file to nightly"
+yq eval --inplace '.version = "nightly"' $antora_file
+yq eval --inplace '.prerelease = true' $antora_file
+
+echo "Committing..."
+git add "$antora_file"
+git commit -m "Bumped back to nightly"
+
+echo ""
+echo "Done! Please push manually:"
+echo "git push --set-upstream origin $branch_name"

supplemental-ui/partials/navbar.hbs

@@ -1,12 +1,12 @@
-<a class="navbar-sub-item" href="{{{ relativize "/home/index.html" }}}">Home</a>
-<a class="navbar-sub-item" href="{{{ relativize "/home/getting_started.html" }}}">Getting Started</a>
-<a class="navbar-sub-item" href="{{{ relativize "/home/concepts/index.html" }}}">Concepts</a>
-<a class="navbar-sub-item" href="{{{ relativize "/home/tutorials/end-to-end_data_pipeline_example.html" }}}">Tutorials</a>
+<a class="navbar-sub-item" href="{{{ relativize "/home/stable/index.html" }}}">Home</a>
+<a class="navbar-sub-item" href="{{{ relativize "/home/stable/getting_started.html" }}}">Getting Started</a>
+<a class="navbar-sub-item" href="{{{ relativize "/home/stable/concepts/index.html" }}}">Concepts</a>
+<a class="navbar-sub-item" href="{{{ relativize "/home/stable/tutorials/end-to-end_data_pipeline_example.html" }}}">Tutorials</a>
 <a class="navbar-sub-item" href="{{{ relativize "/stackablectl/stable/index.html" }}}">stackablectl</a>
 <div class="navbar-sub-item drop-down">
     Operators
     <div class="drop-down-content">
-    <a class="drop-down-item" href="{{{ relativize "/home/operators/index.html" }}}">Overview</a>
+    <a class="drop-down-item" href="{{{ relativize "/home/stable/operators/index.html" }}}">Overview</a>
     <a class="drop-down-item" href="{{{ relativize "/airflow/stable/index.html" }}}">Apache Airflow</a>
     <a class="drop-down-item" href="{{{ relativize "/druid/stable/index.html" }}}">Apache Druid</a>
     <a class="drop-down-item" href="{{{ relativize "/hbase/stable/index.html" }}}">Apache HBase</a>
@@ -23,4 +23,4 @@
     <a class="drop-down-item" href="{{{ relativize "/secret-operator/stable/index.html" }}}">Secret</a>
     </div>
 </div>
-<a class="navbar-sub-item" href="{{{ relativize "/home/contributor/index.html" }}}">Contribute</a>
+<a class="navbar-sub-item" href="{{{ relativize "/home/stable/contributor/index.html" }}}">Contribute</a>