Skip to content

Commit

Permalink
Tidying up configuration files. (#135)
Browse files Browse the repository at this point in the history
* Tidying up configuration files.

* Was using old link checker
* Was lacking the linked SQL On Viridian repo
* No need to declare robots as an external file
* Upgraded the antora dependency versions.

* Updating validate.yml

* Upgrade node version
* Remove the external link checking step
  • Loading branch information
Serdaro authored Sep 25, 2023
1 parent a3c0681 commit e67333b
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 16 deletions.
8 changes: 1 addition & 7 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,8 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 10
node-version: 16
- name: Check for broken internal links
run: |
npm i
npm run-script check-links-local
- name: Check for broken external links
run: |
sudo apt-get update && sudo apt-get install wget libtinfo5 -y
wget https://github.com/smallhadroncollider/brok/releases/download/1.1.0/brok-1.1.0_x86-64-linux.deb
sudo dpkg -i brok-1.1.0_x86-64-linux.deb
brok --only-failures --interval 500 --ignore $(cat .brok-ignore-links) $(find . -type f -name "*.adoc")
1 change: 1 addition & 0 deletions antora-playbook-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ site:
title: Documentation
url: http:localhost:5000
start_page: cloud::overview.adoc
robots: disallow
keys:
google_analytics: 'GTM-MQ59XD6'
docsearch_id: 'QK2EAH8GB0'
Expand Down
1 change: 1 addition & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ site:
title: Documentation
url: https://xenodochial-spence-280948.netlify.app
start_page: cloud::overview.adoc
robots: disallow
keys:
google_analytics: 'GTM-MQ59XD6'
docsearch_id: 'QK2EAH8GB0'
Expand Down
7 changes: 5 additions & 2 deletions link-check-playbook.yml → check-links-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ site:
title: Documentation
url: http:localhost:5000
content:
sources:
sources:
- url: .
branches: HEAD
start_paths: [./docs, ./tutorials]
Expand All @@ -21,6 +21,9 @@ content:
- url: https://github.com/hazelcast/hz-docs
branches: [main, v/*]
start_path: docs
- url: https://github.com/hazelcast-guides/sql_basics_on_viridian
branches: master
start_paths: docs
- url: https://github.com/hazelcast-guides/client-failover
branches: master
start_paths: docs
Expand All @@ -42,7 +45,7 @@ content:
- url: https://github.com/hazelcast/hazelcast-commandline-client
branches: [main]
start_path: docs
ui:
ui:
bundle:
url: https://github.com/hazelcast/hazelcast-docs-ui/releases/latest/download/ui-bundle.zip #../hazelcast-docs-ui/build/ui-bundle.zip
snapshot: true
Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
"author": "Jake Cahill",
"license": "ISC",
"scripts": {
"build": "antora --to-dir docs --fetch antora-playbook.yml && cp robots.txt docs",
"build": "antora --to-dir docs --fetch antora-playbook.yml",
"build-local": "antora --to-dir test --fetch antora-playbook-local.yml --stacktrace",
"check-links-local": "antora --fetch --generator @antora/xref-validator link-check-playbook.yml",
"check-links-local": "antora --fetch --to-dir test --log-level=error --log-failure-level=error --extension=@jcahills/antora-link-checker check-links-playbook.yml",
"serve": "serve test",
"expose": "ngrok http 5000"
},
"devDependencies": {
"@antora/cli": "^3.0.0",
"@antora/site-generator": "^3.0.0",
"@antora/xref-validator": "gitlab:antora/xref-validator",
"@antora/cli": "^3.1.1",
"@antora/site-generator": "^3.1.1",
"@jcahills/antora-link-checker": "^1.0.1",
"@djencks/antora-aggregate-collector": "^0.1.0-beta.1",
"asciidoctor-kroki": "^0.15.0",
"ngrok": "^4.2.2",
Expand Down
2 changes: 0 additions & 2 deletions robots.txt

This file was deleted.

0 comments on commit e67333b

Please sign in to comment.