Add global build (#1608)

Author: fantkolja

.github/workflows/validate.yml

@@ -14,4 +14,4 @@ jobs:
       - name: Checkout Current Repo
         uses: actions/checkout@v4
       - name: Validate Docs
-        uses: hazelcast/hazelcast-docs/.github/actions/validate@main
+        uses: hazelcast/hazelcast-docs-tools/.github/actions/validate-docs@actions/v1

.gitignore

@@ -10,3 +10,4 @@
 .vscode/settings.json
 /target/
 .classpath
+global-antora-playbook.yml

README.adoc

@@ -183,6 +183,36 @@ If you want to add a change or contribute new content, see our {url-contribute}[
 
 To let us know about something that you'd like us to change, consider {url-org}/hz-docs/issues/new[creating an issue].
 
+== npm scripts
+
+For deployment and development this repository includes the following npm scripts:
+
+.npm scripts
+[cols="m,a,a"]
+|===
+|Script |Description |Notes
+
+|`npm run build`
+|Builds a production version of the docs from this repo
+|This script depends on Netlify env vars (`REPOSITORY_URL` and `BRANCH`) which you can encode using e.g.: `export REPOSITORY_URL=https://github.com/hazelcast/hz-docs && export BRANCH=pull/445/head && npm run build`
+You should generally just use build-local though.
+
+|`npm run build-local`
+|Builds a local version of the docs from this repo
+|By default, it will build all content sources taken from the link:https://github.com/hazelcast/hazelcast-docs/blob/main/antora-playbook.yml[global antora-playbook]. But if you want to build less, please modify the local link:./antora-playbook.yml[antora-playbook].
+
+|`npm run validate-docs`
+|Validates docs
+|It will take into consideration all content sources taken from the link:https://github.com/hazelcast/hazelcast-docs/blob/main/antora-playbook.yml[global antora-playbook].
+
+|`npm run check-orphan-pages`
+|Checks orphan pages
+|
+|===
+
+NOTE: Before running any of the scripts please make sure you have installed all latest npm packages via `npm i`.
+
+
 == License
 
 All documentation is available under the terms of a link:{url-cc}[Creative Commons License]

antora-playbook-local.yml

@@ -1,43 +1,32 @@
+# uncomment any of the sections to overwrite the global antora-playbook.yml
+
 site:
-  title: Documentation
+#  title: Documentation
   url: https://hardcore-allen-f5257d.netlify.app/
   start_page: hazelcast:ROOT:what-is-hazelcast.adoc
   robots: disallow
-  keys:
-    docsearch_id: 'QK2EAH8GB0'
-    docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5'
-    docsearch_index: 'prod_hazelcast_docs'
-    ai_search_id: '6b326171-dd1e-40c6-a948-1f9bb6c0ed52'
-content:
-  sources:
-  - url: .
-    branches: HEAD
-    start_path: docs
-  - url: https://github.com/hazelcast/hazelcast-mono
-    branches: [master]
-    start_path: docs/rest
+#  keys:
+#    docsearch_id: 'QK2EAH8GB0'
+#    docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5'
+#    docsearch_index: 'prod_hazelcast_docs'
+#    ai_search_id: '6b326171-dd1e-40c6-a948-1f9bb6c0ed52'
+#content:
+#  sources:
+#  - url: .
+#    branches: HEAD
+#    start_path: docs
+#  - url: https://github.com/hazelcast/hazelcast-mono
+#    branches: [master]
+#    start_path: docs/rest
 #  - url: https://github.com/hazelcast/hazelcast-code-samples
 #    branches: [test/docs]
 #    start_path: docs
-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
-asciidoc:
-  attributes:
-    # Download images from kroki at build time (does not work for inline images)
-    kroki-fetch-diagram: true
-    # Include next and previous links on each page
-    page-pagination: true
-    idprefix: ''
-    # Separate anchor link names by dashes
-    idseparator: '-'
-    # Variables used in the docs
-    page-survey: https://www.surveymonkey.co.uk/r/NYGJNF9
-    hazelcast-cloud: Cloud
-    ucn: User Code Namespaces
-    ucd: User Code Deployment
-  extensions:
-    - ./node_modules/hazelcast-docs-tools/antora-macro/tabs-block.js
-    - asciidoctor-kroki
-    - ./node_modules/hazelcast-docs-tools/antora-macro/swagger-ui-block-macro.js
+#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
+#asciidoc:
+#  extensions:
+#    - ./node_modules/hazelcast-docs-tools/antora-macro/tabs-block.js
+#    - asciidoctor-kroki
+#    - ./node_modules/hazelcast-docs-tools/antora-macro/swagger-ui-block-macro.js

antora-playbook.yml

@@ -5,18 +5,22 @@
   "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",
+    "load-antora-playbook": "load-global-playbook",
+    "build": "npm run load-antora-playbook && antora --to-dir docs --fetch global-antora-playbook.yml",
+    "load-antora-playbook-local": "load-global-playbook -b main -r hazelcast/hz-docs --skip-private-repos",
+    "build-local": "npm run load-antora-playbook-local && antora --to-dir test --fetch global-antora-playbook.yml",
+    "load-validate-docs-playbook": "load-global-playbook -b main -r hazelcast/hz-docs --skip-private-repos --enforce-global-sources",
+    "validate-docs": "npm run load-validate-docs-playbook && antora --fetch --to-dir test --log-level=warn --log-failure-level=warn --extension=./node_modules/hazelcast-docs-tools/antora-extensions/antora-link-checker-extension.js global-antora-playbook.yml",
+    "check-orphan-pages": "check-orphan-pages --log-failure-level=error",
     "serve": "serve test",
-    "expose": "ngrok http 5000"
+    "expose": "ngrok http 3000"
   },
   "devDependencies": {
     "@antora/cli": "^3.1.1",
     "@antora/site-generator": "^3.1.1",
     "@asciidoctor/core": "^2.0.0",
     "asciidoctor-kroki": "^0.10.0",
-    "hazelcast-docs-tools": "github:hazelcast/hazelcast-docs-tools#v1.1.0",
+    "hazelcast-docs-tools": "github:hazelcast/hazelcast-docs-tools#v2.1.0",
     "ngrok": "^5.0.0-beta.2",
     "serve": "^14.2.4"
   },