From 9dfde3463c8056ebf6b1e931e9c9d6104fc6872a Mon Sep 17 00:00:00 2001
From: Nick Larsen <nick.larsen@stackable.tech>
Date: Mon, 22 Jul 2024 11:14:34 +0200
Subject: [PATCH] chore(getting-started): add warning to generated script

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

diff --git a/docs/modules/spark-k8s/examples/getting_started/getting_started.sh b/docs/modules/spark-k8s/examples/getting_started/getting_started.sh
index 8dcc2188..7dc9fac9 100755
--- a/docs/modules/spark-k8s/examples/getting_started/getting_started.sh
+++ b/docs/modules/spark-k8s/examples/getting_started/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
+#   spark: 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/spark-k8s/examples/getting_started/getting_started.sh.j2 b/docs/modules/spark-k8s/examples/getting_started/getting_started.sh.j2
index 1af6ea83..9cbda5a2 100755
--- a/docs/modules/spark-k8s/examples/getting_started/getting_started.sh.j2
+++ b/docs/modules/spark-k8s/examples/getting_started/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
+#   spark: 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.