Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add management and demo docs #449

Merged
merged 17 commits into from
Sep 22, 2023
Merged

docs: Add management and demo docs #449

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
65c4fb4
Add Management and Demo docs
sbernauer Sep 12, 2023
8ff1481
Update xrefs and formatting
Techassi Sep 12, 2023
955f0fc
Fix xref
Techassi Sep 18, 2023
299e5d9
Update playbook
Techassi Sep 18, 2023
e35123f
Update discussions link
Techassi Sep 19, 2023
9e87b5d
Update Makefile
Techassi Sep 19, 2023
2bbae78
Fix most internal and external links
Techassi Sep 19, 2023
6ce2744
Update playbooks
Techassi Sep 20, 2023
f484afd
Update top navigation
Techassi Sep 20, 2023
123a71f
Add demo navigation
Techassi Sep 20, 2023
f13d380
Update xref in release notes
Techassi Sep 20, 2023
9b04dfb
Switch back to main branches in playbook
Techassi Sep 21, 2023
2337ef2
Fix branch name in playbook
Techassi Sep 21, 2023
fa566e6
Remove fixup branches from Hive repo
Techassi Sep 21, 2023
1160e85
Apply suggestions
Techassi Sep 22, 2023
8caa375
Remove home component from xrefs
Techassi Sep 22, 2023
7ece357
Merge branch 'main' into add-management-and-demo-docs
Techassi Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ build-ui:
node_modules/.bin/gulp --cwd ui bundle

clean:
rm -r build
rm -rf build
# 'cache' is the configured cache dir in the playbook
rm -r cache
rm -rf cache

# The netlify repo is checked out without any blobs. This script
# iterates through the release branches and checks them out one-by-one
Expand Down
79 changes: 6 additions & 73 deletions antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,12 @@ content:
- release/23.7
- release/23.4
- release/23.1
- release/22.11
- release/22.09
- release/22.06
# stackablectl
- url: https://github.com/stackabletech/stackablectl.git
# management tools
- url: https://github.com/stackabletech/stackable-cockpit.git
start_path: docs
branches: docs/stackablectl
# demos
- url: https://github.com/stackabletech/demos.git
start_path: docs
branches: main
# internal operators
Expand All @@ -36,21 +37,13 @@ content:
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat # (required for 0.4 and below)
- old-release-docs/0.4
- old-release-docs/0.3
- old-release-docs/0.2
- url: https://github.com/stackabletech/secret-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat # (required for 0.6 and below)
tags:
- docs/0.6
- docs/0.5
- url: https://github.com/stackabletech/listener-operator.git
start_path: docs
branches:
Expand All @@ -66,143 +59,83 @@ content:
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat # (required for 0.6 and below)
- old-release-docs/0.6
- old-release-docs/0.5
tags:
- docs/0.4
- url: https://github.com/stackabletech/druid-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
- old-release-docs/0.8
- old-release-docs/0.7
tags:
- docs/0.6
- url: https://github.com/stackabletech/hbase-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
- old-release-docs/0.5
- old-release-docs/0.4
- old-release-docs/0.3
- url: https://github.com/stackabletech/hdfs-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
- old-release-docs/0.6
- old-release-docs/0.5
tags:
- docs/0.4
- url: https://github.com/stackabletech/hive-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
tags:
- docs/0.8
- docs/0.7
- docs/0.6
- url: https://github.com/stackabletech/kafka-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
tags:
- docs/0.8
- docs/0.7
- docs/0.6
- url: https://github.com/stackabletech/nifi-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat # (required for 0.8 and below)
- old-release-docs/0.8
- old-release-docs/0.7
- old-release-docs/0.6
- url: https://github.com/stackabletech/opa-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
tags:
- docs/0.11
- docs/0.10
- docs/0.9
- url: https://github.com/stackabletech/spark-k8s-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
tags:
- docs/0.6
- docs/0.5
- docs/0.4
- docs/0.3
- docs/0.2
- url: https://github.com/stackabletech/superset-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
- old-release-docs/0.7
- old-release-docs/0.6
- old-release-docs/0.5
- url: https://github.com/stackabletech/trino-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
- old-release-docs/0.8
- old-release-docs/0.7
tags:
- docs/0.6
- docs/0.5
- docs/0.4
- url: https://github.com/stackabletech/zookeeper-operator.git
start_path: docs
branches:
- main
- release-23.7
- release-23.4
- release-23.1
- distributed-component-compat
- old-release-docs/0.12
- old-release-docs/0.11
- old-release-docs/0.10

ui:
bundle:
Expand Down
1 change: 1 addition & 0 deletions antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Stackable Documentation
nav:
- modules/ROOT/nav.adoc
- modules/concepts/nav.adoc
- modules/demos/nav.adoc
- modules/tutorials/nav.adoc
- modules/reference/nav.adoc
- modules/operators/nav.adoc
Expand Down
7 changes: 5 additions & 2 deletions gitpod-antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@ content:
- url: /workspace/documentation
tags: []
branches: [HEAD, release/*]
# stackablectl
- url: https://github.com/stackabletech/stackablectl.git
# management tools
- url: https://github.com/stackabletech/stackable-cockpit.git
start_path: docs
# demos
- url: https://github.com/stackabletech/demos.git
start_path: docs
# internal operators
- url: https://github.com/stackabletech/commons-operator.git
Expand Down
Loading
Loading