From 9dfde3463c8056ebf6b1e931e9c9d6104fc6872a Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Mon, 22 Jul 2024 11:14:34 +0200 Subject: [PATCH 1/2] 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 < Date: Mon, 22 Jul 2024 12:06:23 +0200 Subject: [PATCH 2/2] docs(getting-started): update stackablectl op install output using a templated file --- .../spark-k8s/examples/getting_started/install_output.txt | 4 ++++ .../examples/getting_started/install_output.txt.j2 | 4 ++++ .../spark-k8s/pages/getting_started/installation.adoc | 8 ++------ 3 files changed, 10 insertions(+), 6 deletions(-) create mode 100644 docs/modules/spark-k8s/examples/getting_started/install_output.txt create mode 100644 docs/modules/spark-k8s/examples/getting_started/install_output.txt.j2 diff --git a/docs/modules/spark-k8s/examples/getting_started/install_output.txt b/docs/modules/spark-k8s/examples/getting_started/install_output.txt new file mode 100644 index 00000000..1664d30f --- /dev/null +++ b/docs/modules/spark-k8s/examples/getting_started/install_output.txt @@ -0,0 +1,4 @@ +Installed commons=0.0.0-dev operator +Installed secret=0.0.0-dev operator +Installed listener=0.0.0-dev operator +Installed spark-k8s=0.0.0-dev operator diff --git a/docs/modules/spark-k8s/examples/getting_started/install_output.txt.j2 b/docs/modules/spark-k8s/examples/getting_started/install_output.txt.j2 new file mode 100644 index 00000000..38aeb224 --- /dev/null +++ b/docs/modules/spark-k8s/examples/getting_started/install_output.txt.j2 @@ -0,0 +1,4 @@ +Installed commons={{ versions.commons }} operator +Installed secret={{ versions.secret }} operator +Installed listener={{ versions.listener }} operator +Installed spark-k8s={{ versions.spark }} operator diff --git a/docs/modules/spark-k8s/pages/getting_started/installation.adoc b/docs/modules/spark-k8s/pages/getting_started/installation.adoc index 6bcae40f..31356669 100644 --- a/docs/modules/spark-k8s/pages/getting_started/installation.adoc +++ b/docs/modules/spark-k8s/pages/getting_started/installation.adoc @@ -37,12 +37,8 @@ include::example$getting_started/getting_started.sh[tag=stackablectl-install-ope The tool will show ----- -[INFO ] Installing commons operator -[INFO ] Installing secret operator -[INFO ] Installing listener operator -[INFO ] Installing spark-k8s operator ----- +[source] +include::example$getting_started/code/install_output.txt[] TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use stackablectl. For example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].