Dependabot, images, README

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
  steps:
  - uses: actions/checkout@v2
  - name: "Generate site using Antora site action"
- uses: kameshsampath/antora-site-action@v0.2.0
+ uses: kameshsampath/antora-site-action@v0.2.4
  with:
  antora_playbook: antora-playbook.yml
  - name: Deploy to GitHub Pages

README.adoc

@@ -12,4 +12,20 @@ To build the site install Antora and run:
 
  antora antora-playbook.yml
 
+WARNING: Due to a https://gitlab.com/antora/antora/-/issues/745[bug] this will _not_ currently work in Node 16. I recommend using the latest LTS release (14) until the issue is resolved.
+
+== Development
+
+During development, it can be helpful to change the playbook so that the source does point at the local directory instead of the remote git repository:
+
+[source,yaml]
+----
+content:
+ sources:
+ - url: ./
+ branches: HEAD
+----
+
+NOTE: Antora does not recognize git submodules as git repositories
+
 The design & layout comes from our https://github.com/stackabletech/documentation-ui[UI repository].

antora-playbook.yml

@@ -3,10 +3,12 @@ site:
  url: https://docs.stackable.tech
  start_page: home::index.adoc
  robots: allow
+
 content:
  sources: 
  - url: https://github.com/stackabletech/documentation.git
  branches: main
+
 ui:
  bundle:
  url: https://repo.stackable.tech/repository/misc/ui-bundle.zip
@@ -16,3 +18,7 @@ ui:
  contents: |
  static_files: [ .nojekyll ]
  - path: .nojekyll
+
+asciidoc:
+ attributes:
+ base-repo: https://github.com/stackabletech

modules/ROOT/pages/index.adoc

@@ -1,14 +1,4 @@
 = Stackable Documentation
-:toc:
-:toc-placement: preamble
-:toclevels: 1
-:showtitle:
-:base-repo: https://github.com/stackabletech
-:imagesdir: diagrams
-
-// Need some preamble to get TOC:
-{empty}
-
 
 == Introduction