From 5a1e5e5ce19db7de5bb7b5d54bfc7875a3a962db Mon Sep 17 00:00:00 2001
From: Nick Larsen <nick.larsen@stackable.tech>
Date: Mon, 22 Jul 2024 16:30:51 +0200
Subject: [PATCH 1/4] docs(getting-started): update stackablectl op install
 output

---
 .../examples/getting_started/code/install_output.txt      | 8 ++++----
 .../examples/getting_started/code/install_output.txt.j2   | 8 ++++----
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/modules/zookeeper/examples/getting_started/code/install_output.txt b/docs/modules/zookeeper/examples/getting_started/code/install_output.txt
index 8200e203..09c58d5f 100644
--- a/docs/modules/zookeeper/examples/getting_started/code/install_output.txt
+++ b/docs/modules/zookeeper/examples/getting_started/code/install_output.txt
@@ -1,4 +1,4 @@
-[INFO ] Installing commons operator in version 0.0.0-dev
-[INFO ] Installing secret operator in version 0.0.0-dev
-[INFO ] Installing listener operator in version 0.0.0-dev
-[INFO ] Installing zookeeper operator in version 0.0.0-dev
+Installed commons={{ versions.commons }} operator
+Installed secret={{ versions.secret }} operator
+Installed listener={{ versions.listener }} operator
+Installed zookeeper={{ versions.zookeeper }} operator
diff --git a/docs/modules/zookeeper/examples/getting_started/code/install_output.txt.j2 b/docs/modules/zookeeper/examples/getting_started/code/install_output.txt.j2
index 3ad06650..09c58d5f 100644
--- a/docs/modules/zookeeper/examples/getting_started/code/install_output.txt.j2
+++ b/docs/modules/zookeeper/examples/getting_started/code/install_output.txt.j2
@@ -1,4 +1,4 @@
-[INFO ] Installing commons operator in version {{ versions.commons }}
-[INFO ] Installing secret operator in version {{ versions.secret }}
-[INFO ] Installing listener operator in version {{ versions.listener }}
-[INFO ] Installing zookeeper operator in version {{ versions.zookeeper }}
+Installed commons={{ versions.commons }} operator
+Installed secret={{ versions.secret }} operator
+Installed listener={{ versions.listener }} operator
+Installed zookeeper={{ versions.zookeeper }} operator

From f37d0edd3c38236d225b9563c8e517dbc5870f74 Mon Sep 17 00:00:00 2001
From: Nick Larsen <nick.larsen@stackable.tech>
Date: Mon, 22 Jul 2024 16:52:12 +0200
Subject: [PATCH 2/4] chore(getting-started): add warning to generated script

---
 .../getting_started/code/getting_started.sh         | 13 +++++++++++++
 .../getting_started/code/getting_started.sh.j2      | 13 +++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh b/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh
index 783cab2d..90addbef 100755
--- a/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh
+++ b/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh
@@ -1,6 +1,19 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
+# DO NOT EDIT THE SCRIPT
+# Instead, update the j2 template, and regenerate it for dev:
+# cat <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
+# helm:
+#   repo_name: stackable-dev
+#   repo_url: https://repo.stackable.tech/repository/helm-dev/
+# versions:
+#   commons: 0.0.0-dev
+#   listener: 0.0.0-dev
+#   secret: 0.0.0-dev
+#   zookeeper: 0.0.0-dev
+# EOF
+
 # This script contains all the code snippets from the guide, as well as some assert tests
 # to test if the instructions in the guide work. The user *could* use it, but it is intended
 # for testing only.
diff --git a/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh.j2 b/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh.j2
index 0d5fbce5..b6e91771 100755
--- a/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh.j2
+++ b/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh.j2
@@ -1,6 +1,19 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
+# DO NOT EDIT THE SCRIPT
+# Instead, update the j2 template, and regenerate it for dev:
+# cat <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
+# helm:
+#   repo_name: stackable-dev
+#   repo_url: https://repo.stackable.tech/repository/helm-dev/
+# versions:
+#   commons: 0.0.0-dev
+#   listener: 0.0.0-dev
+#   secret: 0.0.0-dev
+#   zookeeper: 0.0.0-dev
+# EOF
+
 # This script contains all the code snippets from the guide, as well as some assert tests
 # to test if the instructions in the guide work. The user *could* use it, but it is intended
 # for testing only.

From 059887177f949fee352dbe81eaa13ded8853d99e Mon Sep 17 00:00:00 2001
From: Nick Larsen <nick.larsen@stackable.tech>
Date: Mon, 22 Jul 2024 16:57:58 +0200
Subject: [PATCH 3/4] chore(shellcheck): defer fixing the warning for now

---
 .../zookeeper/examples/getting_started/code/getting_started.sh   | 1 +
 .../examples/getting_started/code/getting_started.sh.j2          | 1 +
 2 files changed, 2 insertions(+)

diff --git a/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh b/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh
index 90addbef..ee6afc41 100755
--- a/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh
+++ b/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh
@@ -125,6 +125,7 @@ kubectl describe configmap simple-znode
 
 cm_output=$(get_configmap)
 
+# shellcheck disable=SC2181 # wont't fix this now, but ideally we should enable bash strict mode so we can avoid success checks.
 if [[ $? == 0 ]]; then
   echo "ConfigMap retrieved."
 else
diff --git a/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh.j2 b/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh.j2
index b6e91771..704fd6a9 100755
--- a/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh.j2
+++ b/docs/modules/zookeeper/examples/getting_started/code/getting_started.sh.j2
@@ -125,6 +125,7 @@ kubectl describe configmap simple-znode
 
 cm_output=$(get_configmap)
 
+# shellcheck disable=SC2181 # wont't fix this now, but ideally we should enable bash strict mode so we can avoid success checks.
 if [[ $? == 0 ]]; then
   echo "ConfigMap retrieved."
 else

From d6bbfe1c2a6d3a58ed787a3a4b9ea14d46a5a5d9 Mon Sep 17 00:00:00 2001
From: Nick Larsen <nick.larsen@stackable.tech>
Date: Mon, 22 Jul 2024 17:44:42 +0200
Subject: [PATCH 4/4] fix(getting-started): use correct version for rendered
 file

---
 .../examples/getting_started/code/install_output.txt      | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/modules/zookeeper/examples/getting_started/code/install_output.txt b/docs/modules/zookeeper/examples/getting_started/code/install_output.txt
index 09c58d5f..dedac3a2 100644
--- a/docs/modules/zookeeper/examples/getting_started/code/install_output.txt
+++ b/docs/modules/zookeeper/examples/getting_started/code/install_output.txt
@@ -1,4 +1,4 @@
-Installed commons={{ versions.commons }} operator
-Installed secret={{ versions.secret }} operator
-Installed listener={{ versions.listener }} operator
-Installed zookeeper={{ versions.zookeeper }} operator
+Installed commons=0.0.0-dev operator
+Installed secret=0.0.0-dev operator
+Installed listener=0.0.0-dev operator
+Installed zookeeper=0.0.0-dev operator