Skip to content

Commit 1ba1a46

Browse files
authored
docs(getting-started): update stackablectl op install output (#432)
* chore(getting-started): add warning to generated script * docs(getting-started): update stackablectl op install output using a templated file
1 parent a92a2ac commit 1ba1a46

File tree

5 files changed

+36
-6
lines changed

5 files changed

+36
-6
lines changed

docs/modules/spark-k8s/examples/getting_started/getting_started.sh

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
#!/usr/bin/env bash
22
set -euo pipefail
33

4+
# DO NOT EDIT THE SCRIPT
5+
# Instead, update the j2 template, and regenerate it for dev:
6+
# cat <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
7+
# helm:
8+
# repo_name: stackable-dev
9+
# repo_url: https://repo.stackable.tech/repository/helm-dev/
10+
# versions:
11+
# commons: 0.0.0-dev
12+
# listener: 0.0.0-dev
13+
# secret: 0.0.0-dev
14+
# spark: 0.0.0-dev
15+
# EOF
16+
417
# This script contains all the code snippets from the guide, as well as some assert tests
518
# to test if the instructions in the guide work. The user *could* use it, but it is intended
619
# for testing only.

docs/modules/spark-k8s/examples/getting_started/getting_started.sh.j2

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
#!/usr/bin/env bash
22
set -euo pipefail
33

4+
# DO NOT EDIT THE SCRIPT
5+
# Instead, update the j2 template, and regenerate it for dev:
6+
# cat <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
7+
# helm:
8+
# repo_name: stackable-dev
9+
# repo_url: https://repo.stackable.tech/repository/helm-dev/
10+
# versions:
11+
# commons: 0.0.0-dev
12+
# listener: 0.0.0-dev
13+
# secret: 0.0.0-dev
14+
# spark: 0.0.0-dev
15+
# EOF
16+
417
# This script contains all the code snippets from the guide, as well as some assert tests
518
# to test if the instructions in the guide work. The user *could* use it, but it is intended
619
# for testing only.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Installed commons=0.0.0-dev operator
2+
Installed secret=0.0.0-dev operator
3+
Installed listener=0.0.0-dev operator
4+
Installed spark-k8s=0.0.0-dev operator
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Installed commons={{ versions.commons }} operator
2+
Installed secret={{ versions.secret }} operator
3+
Installed listener={{ versions.listener }} operator
4+
Installed spark-k8s={{ versions.spark }} operator

docs/modules/spark-k8s/pages/getting_started/installation.adoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,8 @@ include::example$getting_started/getting_started.sh[tag=stackablectl-install-ope
3737

3838
The tool will show
3939

40-
----
41-
[INFO ] Installing commons operator
42-
[INFO ] Installing secret operator
43-
[INFO ] Installing listener operator
44-
[INFO ] Installing spark-k8s operator
45-
----
40+
[source]
41+
include::example$getting_started/code/install_output.txt[]
4642

4743
TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use stackablectl. For
4844
example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].

0 commit comments

Comments
 (0)