From 516f6ca4e245d51b1f0ed14c931de90d0b75654d Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Tue, 17 Sep 2024 12:19:06 +0300 Subject: [PATCH 1/5] revert adoc templates --- antora-playbook-local.yml | 2 ++ antora-playbook.yml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/antora-playbook-local.yml b/antora-playbook-local.yml index d1fbd15f..75c4e1b9 100644 --- a/antora-playbook-local.yml +++ b/antora-playbook-local.yml @@ -78,6 +78,8 @@ content: - url: https://github.com/hazelcast/hazelcast-cloud-maven-plugin branches: main start_path: docs + - url: https://github.com/hazelcast-guides/adoc-templates.git + branches: antora-doc - url: https://github.com/hazelcast-guides/caching-springboot-jcache branches: master start_path: docs diff --git a/antora-playbook.yml b/antora-playbook.yml index 2fe0d9db..439ca316 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -80,6 +80,8 @@ content: - url: https://github.com/hazelcast/hazelcast-cloud-maven-plugin branches: main start_path: docs + - url: https://github.com/hazelcast-guides/adoc-templates.git + branches: antora-doc - url: https://github.com/hazelcast-guides/caching-springboot-jcache branches: master start_path: docs From cb4e651621dbce8a73d6b0bc6f445341dcb047c1 Mon Sep 17 00:00:00 2001 From: Oliver Howell Date: Fri, 1 Nov 2024 14:42:36 +0000 Subject: [PATCH 2/5] Merge develop into main (#409) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: devOpsHelm Co-authored-by: GitHub Actions Bot <> Co-authored-by: Mykola Fant Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: devopshazelcast Co-authored-by: devOpsHelm <54980549+devOpsHelm@users.noreply.github.com> Co-authored-by: Nishaat Rajabali <12186256+nishaatr@users.noreply.github.com> Co-authored-by: Yüce Tekol --- _redirects | 2 +- antora-playbook.yml | 25 +++++++++++++------------ 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/_redirects b/_redirects index d86af141..846957ad 100644 --- a/_redirects +++ b/_redirects @@ -35,7 +35,7 @@ /clc/latest-dev/* /clc/latest/:splat 200! # Redirect latest clc alias to the latest version -/clc/latest/* /clc/5.4.1/:splat 200! +/clc/latest/* /clc/5.5.0/:splat 200! # Redirect legacy /4 version to the /4.0 version /imdg/4/* /imdg/4.0/:splat 301! diff --git a/antora-playbook.yml b/antora-playbook.yml index 08a506f3..ba1005e3 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,13 +1,18 @@ site: + # https://docs.antora.org/antora/latest/playbook/set-up-playbook/#configure-your-sites-properties title: Documentation start_page: home::index.adoc url: https://docs.hazelcast.com keys: google_analytics: 'GTM-MQ59XD6' + # The following 3 parameters: id, api and index are used for + # Algolia docsearch setup in the hazelcast-docs-ui repo docsearch_id: 'QK2EAH8GB0' docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5' docsearch_index: 'prod_hazelcast_docs' + ai_search_id: '6b326171-dd1e-40c6-a948-1f9bb6c0ed52' urls: + # https://docs.antora.org/antora/latest/playbook/urls-html-extension-style/ html_extension_style: drop content: sources: @@ -19,7 +24,7 @@ content: start_path: docs - url: https://github.com/hazelcast/hz-flow-docs branches: [main] - start_path: docs + start_path: docs - url: https://github.com/hazelcast/imdg-docs branches: [v/*] start_path: docs @@ -224,19 +229,15 @@ content: ui: bundle: url: https://github.com/hazelcast/hazelcast-docs-ui/releases/latest/download/ui-bundle.zip + # https://docs.antora.org/antora/latest/playbook/set-up-playbook/#configure-your-sites-ui-bundle + # When snapshot is set to true, Antora will download the UI bundle + # whenever fetch is activated in the playbook or from the CLI. snapshot: true + # Needed for API calls from Cloud Web App (Learning Centre page) supplemental_files: - path: netlify.toml contents: > [[headers]] - - - - - - - - for = "/api/*" [headers.values] Access-Control-Allow-Origin = "*" @@ -272,9 +273,6 @@ antora: branch: includes: - '5.6.0' - - require: '@djencks/antora-aggregate-collector' - trace: true - componentversions: - name: hazelcast version: '5.5' mappings: @@ -389,9 +387,12 @@ asciidoc: # Order the products in the version selector dropdown. # Use * to list all remaining products in alphabetical order. page-component-order: 'hazelcast, management-center, cloud, *' + # https://docs.antora.org/antora/latest/playbook/asciidoc-attributes/#precedence-rules + # page-pagination is soft-set to true page-pagination: true@ # Allows us to use UI macros. See https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/ page-experimental: true + # AsciiDoc ID settings https://docs.asciidoctor.org/asciidoc/latest/sections/id-prefix-and-separator/ idprefix: '' idseparator: '-' imdg-javadoc: https://docs.hazelcast.org/docs/latest-dev/javadoc From 485a07196c82995c7def788557619df7d2cef13f Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Fri, 15 Nov 2024 12:26:02 +0200 Subject: [PATCH 3/5] add reusable parts for global check-links across docs repos --- .github/actions/validate/action.yml | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/.github/actions/validate/action.yml b/.github/actions/validate/action.yml index 8eef321e..e1533b33 100644 --- a/.github/actions/validate/action.yml +++ b/.github/actions/validate/action.yml @@ -9,17 +9,6 @@ runs: node-version: 20 cache: 'npm' - - name: Checkout global antora-playbook - uses: actions/checkout@v4 - with: - repository: hazelcast/hazelcast-docs - sparse-checkout: | - antora-playbook.yml - lib/load-check-links-playbook.js - sparse-checkout-cone-mode: false - path: hazelcast-docs - ref: main - - name: Check for broken internal links shell: bash run: | From f48a2f403e5b7b3d1a63ab09c0afffa3e8af7ad2 Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Fri, 15 Nov 2024 12:30:01 +0200 Subject: [PATCH 4/5] add reusable parts for global check-links across docs repos --- .github/actions/{validate => validate@1}/action.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/actions/{validate => validate@1}/action.yml (100%) diff --git a/.github/actions/validate/action.yml b/.github/actions/validate@1/action.yml similarity index 100% rename from .github/actions/validate/action.yml rename to .github/actions/validate@1/action.yml From 504580f036cd260155c441e8042090b7286ecf50 Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Fri, 15 Nov 2024 12:39:43 +0200 Subject: [PATCH 5/5] add reusable parts for global check-links across docs repos --- .github/actions/{validate@1 => validate}/action.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/actions/{validate@1 => validate}/action.yml (100%) diff --git a/.github/actions/validate@1/action.yml b/.github/actions/validate/action.yml similarity index 100% rename from .github/actions/validate@1/action.yml rename to .github/actions/validate/action.yml