Skip to content

Commit

Permalink
DOC-305: orphan pages detector (#428)
Browse files Browse the repository at this point in the history
Implements https://hazelcast.atlassian.net/browse/DOC-305

Please note, we probably can close
https://hazelcast.atlassian.net/browse/DOC-304 if this implementation is
OK
  • Loading branch information
fantkolja authored Jan 13, 2025
1 parent 367ecc6 commit 2cf69bb
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 108 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Check for dead links
name: Docs validation

on:
pull_request:
Expand All @@ -13,5 +13,5 @@ jobs:
steps:
- name: Checkout Current Repo
uses: actions/checkout@v4
- name: Check dead links
- name: Validate Docs
uses: hazelcast/hazelcast-docs/.github/actions/validate@main
4 changes: 2 additions & 2 deletions antora-playbook-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ asciidoc:
docs-archive: 'https://hazelcast.org/imdg/download/archives/'
hazelcast-cloud: Cloud
extensions:
- ./lib/tabs-block.js
- ./lib/swagger-ui-block-macro.js
- ./node_modules/hazelcast-docs-tools/antora-macro/tabs-block.js
- ./node_modules/hazelcast-docs-tools/antora-macro/swagger-ui-block-macro.js
4 changes: 2 additions & 2 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ asciidoc:
docs-archive: 'https://hazelcast.org/imdg/download/archives/'
hazelcast-cloud: Cloud
extensions:
- ./lib/tabs-block.js
- ./lib/swagger-ui-block-macro.js
- ./node_modules/hazelcast-docs-tools/antora-macro/tabs-block.js
- ./node_modules/hazelcast-docs-tools/antora-macro/swagger-ui-block-macro.js
2 changes: 1 addition & 1 deletion docs/modules/getting-started/partials/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
** User Interface Overview
*** xref:getting-started:user-interface.adoc[Top Bar and Side Bar]
*** xref:getting-started:graphs.adoc[]
*** xref:getting-started:tables.adoc[]
*** xref:getting-started:tables.adoc[]
20 changes: 0 additions & 20 deletions lib/swagger-ui-block-macro.js

This file was deleted.

80 changes: 0 additions & 80 deletions lib/tabs-block.js

This file was deleted.

15 changes: 15 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@
"name": "hazelcast-docs-playbook",
"version": "1.0.0",
"description": "Hazelcast Antora project.",
"author": "SerdarO",
"author": "Hazelcast Docs",
"license": "ISC",
"scripts": {
"build": "antora --to-dir docs --fetch antora-playbook.yml",
"build-local": "antora --to-dir test --fetch antora-playbook-local.yml",
"check-orphan-pages": "check-orphan-pages --log-failure-level=error",
"serve": "serve test",
"expose": "ngrok http 5000"
},
"devDependencies": {
"@antora/cli": "^3.1.1",
"@antora/site-generator": "^3.1.1",
"asciidoctor-kroki": "^0.10.0",
"hazelcast-docs-tools": "github:hazelcast/hazelcast-docs-tools#v1.1.0",
"ngrok": "^4.2.2",
"serve": "^13.0.2"
}
Expand Down

0 comments on commit 2cf69bb

Please sign in to comment.