Skip to content

Commit 7d24cae

Browse files
authored
Documentation overhaul (#148)
- Search integration - Custom start page - Antora 3
1 parent 5dbec40 commit 7d24cae

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+3993
-4885
lines changed

.github/dependabot.yml

Lines changed: 0 additions & 10 deletions
This file was deleted.

.github/workflows/build.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- uses: actions/[email protected]
15-
- name: "Generate site using Antora site action"
16-
uses: kameshsampath/[email protected]
15+
- uses: actions/setup-node@v2
1716
with:
18-
antora_playbook: antora-playbook.yml
17+
node-version: '16'
18+
cache: 'npm'
19+
- run: npm install
20+
- run: npx antora --fetch local-antora-playbook.yml

.github/workflows/deploy.yml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,15 @@ jobs:
1717
runs-on: ubuntu-latest
1818
steps:
1919
- uses: actions/[email protected]
20-
- name: "Generate site using Antora site action"
21-
uses: kameshsampath/[email protected]
20+
- uses: actions/setup-node@v2
2221
with:
23-
antora_playbook: antora-playbook.yml
24-
- name: Deploy to GitHub Pages
25-
uses: JamesIves/[email protected]
22+
node-version: '16'
23+
cache: 'npm'
24+
- run: npm install
25+
- run: npx antora --fetch local-antora-playbook.yml
26+
- name: Publish to GitHub Pages
27+
uses: peaceiris/actions-gh-pages@v3
2628
with:
27-
branch: 'docs'
28-
folder: 'build/site'
29+
github_token: ${{ secrets.GITHUB_TOKEN }}
30+
publish_dir: build/site
31+
publish_branch: docs

antora-playbook.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
---
12
site:
23
title: Stackable Documentation
34
url: https://docs.stackable.tech
4-
start_page: home::index.adoc
55
robots: allow
66

77
content:
@@ -48,13 +48,13 @@ content:
4848

4949
ui:
5050
bundle:
51-
url: https://repo.stackable.tech/repository/misc/ui-bundle.zip
51+
url: https://repo.stackable.tech/repository/misc/antora-ui-bundle.zip
5252
snapshot: true
53-
supplemental_files:
54-
- path: ui.yml
55-
contents: |
56-
static_files: [ .nojekyll ]
57-
- path: .nojekyll
53+
supplemental_files: ./node_modules/@antora/lunr-extension/supplemental_ui
54+
55+
antora:
56+
extensions:
57+
- '@antora/lunr-extension'
5858

5959
asciidoc:
6060
attributes:

build_maturity_level_docs.py

Lines changed: 0 additions & 38 deletions
This file was deleted.

generate_site.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/env bash
2+
3+
npx antora --fetch $1

gitpod-antora-playbook.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
---
12
site:
23
title: Stackable Documentation
34
url: https://docs.stackable.tech
4-
start_page: home::index.adoc
55
robots: allow
66

77
content:
@@ -48,13 +48,13 @@ content:
4848

4949
ui:
5050
bundle:
51-
url: https://repo.stackable.tech/repository/misc/ui-bundle.zip
51+
url: https://repo.stackable.tech/repository/misc/antora-ui-bundle.zip
5252
snapshot: true
53-
supplemental_files:
54-
- path: ui.yml
55-
contents: |
56-
static_files: [ .nojekyll ]
57-
- path: .nojekyll
53+
supplemental_files: ./node_modules/@antora/lunr-extension/supplemental_ui
54+
55+
antora:
56+
extensions:
57+
- '@antora/lunr-extension'
5858

5959
asciidoc:
6060
attributes:

local-antora-playbook.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
site:
23
title: Stackable Documentation
34
url: https://docs.stackable.tech
@@ -48,13 +49,13 @@ content:
4849

4950
ui:
5051
bundle:
51-
url: https://repo.stackable.tech/repository/misc/ui-bundle.zip
52+
url: https://repo.stackable.tech/repository/misc/antora-ui-bundle.zip
5253
snapshot: true
53-
supplemental_files:
54-
- path: ui.yml
55-
contents: |
56-
static_files: [ .nojekyll ]
57-
- path: .nojekyll
54+
supplemental_files: ./node_modules/@antora/lunr-extension/supplemental_ui
55+
56+
antora:
57+
extensions:
58+
- '@antora/lunr-extension'
5859

5960
asciidoc:
6061
attributes:

maturity_levels/components.csv

Lines changed: 0 additions & 35 deletions
This file was deleted.

maturity_levels/templates/apache_hadoop_hdfs.j2

Lines changed: 0 additions & 54 deletions
This file was deleted.

maturity_levels/templates/apache_hadoop_yarn.j2

Lines changed: 0 additions & 33 deletions
This file was deleted.

maturity_levels/templates/apache_kafka.j2

Lines changed: 0 additions & 31 deletions
This file was deleted.

maturity_levels/templates/apache_nifi.j2

Lines changed: 0 additions & 30 deletions
This file was deleted.

maturity_levels/templates/apache_spark.j2

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)