Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
build/
cache/
.idea/
node_modules/
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,9 @@ build:
node_modules/.bin/gulp --cwd ui bundle
node_modules/.bin/antora generate $(PLAYBOOK) $(ANTORAFLAGS)

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

.PHONY: build
6 changes: 3 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
:base-repo: https://github.com/stackabletech

This is the main repository for the documentation of the Stackable platform.
It uses https://antora.org[Antora].
Have a look at the https://docs.stackable.tech/[live version].

This repository hosts the Antora playbook file as well as some generic documentation modules.
The documentation is built with https://antora.org[Antora]. This repository hosts the Antora playbook file as well as platform documentation. Other Stackable repos contain 'docs' directories which are pulled in by this repo.

To build the site, pull submodules, install dependencies and run `make`:

Expand All @@ -17,7 +17,7 @@ $ npm ci
$ make
----

NOTE: Antora caches all resources it downloads in the user's cache directory (e.g. `~/.cache/antora` directory on Linux). It will _not_ automatically update those. Use the `--fetch` flag (`make ANTORAFLAGS=--fetch`) to update all sources.
NOTE: Antora caches the external content repos in the cache directory (configured to be `./cache`). It will _not_ automatically update those. Use the `--fetch` flag (`make ANTORAFLAGS=--fetch`) to update all sources, or use `make clean` to delete the `cache` and `build` directory.

== Development

Expand Down
6 changes: 6 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,9 @@ asciidoc:
plantuml-server-url: http://www.plantuml.com/plantuml
extensions:
- asciidoctor-kroki

# the default caching directory is ./.cache/antora
# Antora caches the git repos, this can sometimes lead to stale content
# use 'make clean' to remove the build and cache directory
runtime:
cache_dir: ./cache
6 changes: 6 additions & 0 deletions gitpod-antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,9 @@ asciidoc:
plantuml-server-url: http://www.plantuml.com/plantuml
extensions:
- asciidoctor-kroki

# the default caching directory is ./.cache/antora
# Antora caches the git repos, this can sometimes lead to stale content
# use 'make clean' to remove the build and cache directory
runtime:
cache_dir: ./cache
6 changes: 6 additions & 0 deletions local-antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,9 @@ asciidoc:
kroki-fetch-diagram: true
extensions:
- asciidoctor-kroki

# the default caching directory is ./.cache/antora
# Antora caches the git repos, this can sometimes lead to stale content
# use 'make clean' to remove the build and cache directory
runtime:
cache_dir: ./cache