Skip to content

Commit f1691c3

Browse files
authored
Build with docker (#163)
* Added example for building the documentation with a Docker utility container. * Revert changes to local-antora-playbook.yml * Fix README
1 parent 8f31036 commit f1691c3

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

README.adoc

+9
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,12 @@ The design & layout comes from our https://github.com/stackabletech/documentatio
3838

3939
A remote vscode instance can be used via https://gitpod.io/#/github.com/stackabletech/documentation
4040

41+
=== Generate the documentation with a Docker utility container
42+
43+
This method has the advantage that you don't need a local installation of Antora. The image `docker.stackable.tech/stackable/antora:3.0.1-stackable0` comes bundled with the required https://gitlab.com/antora/antora-lunr-extension[lunr] extension.
44+
45+
[source,bash]
46+
----
47+
docker run -u $(id -u) -v $PWD:/antora:Z -w /antora --rm -t docker.stackable.tech/stackable/antora:3.0.1-stackable0 docker-antora-playbook.yml
48+
----
49+

docker-antora-playbook.yml

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
site:
3+
title: Stackable Documentation
4+
url: https://docs.stackable.tech
5+
start_page: home::index.adoc
6+
robots: allow
7+
8+
content:
9+
sources:
10+
- url: ./
11+
branches: HEAD
12+
13+
- url: https://github.com/stackabletech/secret-operator.git
14+
branches: main
15+
start_path: docs
16+
17+
- url: https://github.com/stackabletech/airflow-operator.git
18+
branches: main
19+
start_path: docs
20+
- url: https://github.com/stackabletech/druid-operator.git
21+
branches: main
22+
start_path: docs
23+
- url: https://github.com/stackabletech/hbase-operator.git
24+
branches: main
25+
start_path: docs
26+
- url: https://github.com/stackabletech/hdfs-operator.git
27+
branches: main
28+
start_path: docs
29+
- url: https://github.com/stackabletech/hive-operator.git
30+
branches: main
31+
start_path: docs
32+
- url: https://github.com/stackabletech/kafka-operator.git
33+
branches: main
34+
start_path: docs
35+
- url: https://github.com/stackabletech/nifi-operator.git
36+
branches: main
37+
start_path: docs
38+
- url: https://github.com/stackabletech/opa-operator.git
39+
branches: main
40+
start_path: docs
41+
- url: https://github.com/stackabletech/spark-operator.git
42+
branches: main
43+
start_path: docs
44+
- url: https://github.com/stackabletech/superset-operator.git
45+
branches: main
46+
start_path: docs
47+
- url: https://github.com/stackabletech/trino-operator.git
48+
branches: main
49+
start_path: docs
50+
- url: https://github.com/stackabletech/zookeeper-operator.git
51+
branches: main
52+
start_path: docs
53+
54+
ui:
55+
bundle:
56+
url: https://repo.stackable.tech/repository/misc/antora-ui-bundle.zip
57+
snapshot: true
58+
supplemental_files: /usr/local/share/.config/yarn/global/node_modules/@antora/lunr-extension/supplemental_ui
59+
60+
antora:
61+
extensions:
62+
- '@antora/lunr-extension'
63+
64+
asciidoc:
65+
attributes:
66+
base-repo: https://github.com/stackabletech

0 commit comments

Comments
 (0)