Skip to content

Commit 5e6aeee

Browse files
Techassisbernauerfhennig
committed
docs: Add management and demo docs (#449)
* Add Management and Demo docs * Update xrefs and formatting * Fix xref * Update playbook * Update discussions link * Update Makefile * Fix most internal and external links * Update playbooks * Update top navigation * Add demo navigation * Update xref in release notes * Switch back to main branches in playbook * Fix branch name in playbook * Remove fixup branches from Hive repo * Apply suggestions Co-authored-by: Felix Hennig <fhennig@users.noreply.github.com> * Remove home component from xrefs --------- Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.de> Co-authored-by: Felix Hennig <fhennig@users.noreply.github.com>
1 parent 5ba83b5 commit 5e6aeee

File tree

16 files changed

+419
-341
lines changed

16 files changed

+419
-341
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ build-ui:
1010
node_modules/.bin/gulp --cwd ui bundle
1111

1212
clean:
13-
rm -r build
13+
rm -rf build
1414
# 'cache' is the configured cache dir in the playbook
15-
rm -r cache
15+
rm -rf cache
1616

1717
# The netlify repo is checked out without any blobs. This script
1818
# iterates through the release branches and checks them out one-by-one

antora-playbook.yml

Lines changed: 6 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@ content:
2121
- release/23.7
2222
- release/23.4
2323
- release/23.1
24-
- release/22.11
25-
- release/22.09
26-
- release/22.06
27-
# stackablectl
28-
- url: https://github.com/stackabletech/stackablectl.git
24+
# management tools
25+
- url: https://github.com/stackabletech/stackable-cockpit.git
26+
start_path: docs
27+
branches: docs/stackablectl
28+
# demos
29+
- url: https://github.com/stackabletech/demos.git
2930
start_path: docs
3031
branches: main
3132
# internal operators
@@ -36,21 +37,13 @@ content:
3637
- release-23.7
3738
- release-23.4
3839
- release-23.1
39-
- distributed-component-compat # (required for 0.4 and below)
40-
- old-release-docs/0.4
41-
- old-release-docs/0.3
42-
- old-release-docs/0.2
4340
- url: https://github.com/stackabletech/secret-operator.git
4441
start_path: docs
4542
branches:
4643
- main
4744
- release-23.7
4845
- release-23.4
4946
- release-23.1
50-
- distributed-component-compat # (required for 0.6 and below)
51-
tags:
52-
- docs/0.6
53-
- docs/0.5
5447
- url: https://github.com/stackabletech/listener-operator.git
5548
start_path: docs
5649
branches:
@@ -66,143 +59,83 @@ content:
6659
- release-23.7
6760
- release-23.4
6861
- release-23.1
69-
- distributed-component-compat # (required for 0.6 and below)
70-
- old-release-docs/0.6
71-
- old-release-docs/0.5
72-
tags:
73-
- docs/0.4
7462
- url: https://github.com/stackabletech/druid-operator.git
7563
start_path: docs
7664
branches:
7765
- main
7866
- release-23.7
7967
- release-23.4
8068
- release-23.1
81-
- distributed-component-compat
82-
- old-release-docs/0.8
83-
- old-release-docs/0.7
84-
tags:
85-
- docs/0.6
8669
- url: https://github.com/stackabletech/hbase-operator.git
8770
start_path: docs
8871
branches:
8972
- main
9073
- release-23.7
9174
- release-23.4
9275
- release-23.1
93-
- distributed-component-compat
94-
- old-release-docs/0.5
95-
- old-release-docs/0.4
96-
- old-release-docs/0.3
9776
- url: https://github.com/stackabletech/hdfs-operator.git
9877
start_path: docs
9978
branches:
10079
- main
10180
- release-23.7
10281
- release-23.4
10382
- release-23.1
104-
- distributed-component-compat
105-
- old-release-docs/0.6
106-
- old-release-docs/0.5
107-
tags:
108-
- docs/0.4
10983
- url: https://github.com/stackabletech/hive-operator.git
11084
start_path: docs
11185
branches:
11286
- main
11387
- release-23.7
11488
- release-23.4
11589
- release-23.1
116-
- distributed-component-compat
117-
tags:
118-
- docs/0.8
119-
- docs/0.7
120-
- docs/0.6
12190
- url: https://github.com/stackabletech/kafka-operator.git
12291
start_path: docs
12392
branches:
12493
- main
12594
- release-23.7
12695
- release-23.4
12796
- release-23.1
128-
- distributed-component-compat
129-
tags:
130-
- docs/0.8
131-
- docs/0.7
132-
- docs/0.6
13397
- url: https://github.com/stackabletech/nifi-operator.git
13498
start_path: docs
13599
branches:
136100
- main
137101
- release-23.7
138102
- release-23.4
139103
- release-23.1
140-
- distributed-component-compat # (required for 0.8 and below)
141-
- old-release-docs/0.8
142-
- old-release-docs/0.7
143-
- old-release-docs/0.6
144104
- url: https://github.com/stackabletech/opa-operator.git
145105
start_path: docs
146106
branches:
147107
- main
148108
- release-23.7
149109
- release-23.4
150110
- release-23.1
151-
- distributed-component-compat
152-
tags:
153-
- docs/0.11
154-
- docs/0.10
155-
- docs/0.9
156111
- url: https://github.com/stackabletech/spark-k8s-operator.git
157112
start_path: docs
158113
branches:
159114
- main
160115
- release-23.7
161116
- release-23.4
162117
- release-23.1
163-
- distributed-component-compat
164-
tags:
165-
- docs/0.6
166-
- docs/0.5
167-
- docs/0.4
168-
- docs/0.3
169-
- docs/0.2
170118
- url: https://github.com/stackabletech/superset-operator.git
171119
start_path: docs
172120
branches:
173121
- main
174122
- release-23.7
175123
- release-23.4
176124
- release-23.1
177-
- distributed-component-compat
178-
- old-release-docs/0.7
179-
- old-release-docs/0.6
180-
- old-release-docs/0.5
181125
- url: https://github.com/stackabletech/trino-operator.git
182126
start_path: docs
183127
branches:
184128
- main
185129
- release-23.7
186130
- release-23.4
187131
- release-23.1
188-
- distributed-component-compat
189-
- old-release-docs/0.8
190-
- old-release-docs/0.7
191-
tags:
192-
- docs/0.6
193-
- docs/0.5
194-
- docs/0.4
195132
- url: https://github.com/stackabletech/zookeeper-operator.git
196133
start_path: docs
197134
branches:
198135
- main
199136
- release-23.7
200137
- release-23.4
201138
- release-23.1
202-
- distributed-component-compat
203-
- old-release-docs/0.12
204-
- old-release-docs/0.11
205-
- old-release-docs/0.10
206139

207140
ui:
208141
bundle:

antora.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title: Stackable Documentation
44
nav:
55
- modules/ROOT/nav.adoc
66
- modules/concepts/nav.adoc
7+
- modules/demos/nav.adoc
78
- modules/tutorials/nav.adoc
89
- modules/reference/nav.adoc
910
- modules/operators/nav.adoc

gitpod-antora-playbook.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,11 @@ content:
1818
- url: /workspace/documentation
1919
tags: []
2020
branches: [HEAD, release/*]
21-
# stackablectl
22-
- url: https://github.com/stackabletech/stackablectl.git
21+
# management tools
22+
- url: https://github.com/stackabletech/stackable-cockpit.git
23+
start_path: docs
24+
# demos
25+
- url: https://github.com/stackabletech/demos.git
2326
start_path: docs
2427
# internal operators
2528
- url: https://github.com/stackabletech/commons-operator.git

0 commit comments

Comments
 (0)