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 08eecf7683c0ee7c1dbb3cde87af15bdf49d3f80 Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Tue, 1 Oct 2024 17:17:32 +0300 Subject: [PATCH 2/5] add comments to build config --- antora-playbook-local.yml | 1 - antora-playbook.yml | 87 +++++++++++++-------------------------- 2 files changed, 29 insertions(+), 59 deletions(-) diff --git a/antora-playbook-local.yml b/antora-playbook-local.yml index 75c4e1b9..4edef396 100644 --- a/antora-playbook-local.yml +++ b/antora-playbook-local.yml @@ -363,4 +363,3 @@ asciidoc: extensions: - ./lib/tabs-block.js - ./lib/swagger-ui-block-macro.js - - asciidoctor-kroki diff --git a/antora-playbook.yml b/antora-playbook.yml index 439ca316..4edef396 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,14 +1,12 @@ site: title: Documentation start_page: home::index.adoc - url: https://docs.hazelcast.com + url: http:localhost:3000 keys: - google_analytics: 'GTM-MQ59XD6' docsearch_id: 'QK2EAH8GB0' docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5' docsearch_index: 'prod_hazelcast_docs' -urls: - html_extension_style: drop + ai_search_id: 'ad664bf0-07e2-42e7-9150-2e1b04b15cca' content: sources: - url: . @@ -193,15 +191,18 @@ content: - url: https://github.com/hazelcast-guides/serverless-trade-monitor-dashboard branches: master start_path: docs - - url: https://github.com/hazelcast/hazelcast-mono - branches: [master, 5.5.0] - start_path: docs/rest - - url: https://github.com/hazelcast/management-center - branches: [master, 5.4.0, 5.5.0] - start_path: hazelcast-management-center/src/openapi/external - - url: https://github.com/hazelcast/management-center - branches: [5.1.z, 5.2.z, 5.3.0] - start_path: openapi/external + # Uncomment to build Swagger docs locally + # These are private repos. You need to do private repository authentication. + # See [here](https://docs.antora.org/antora/latest/playbook/private-repository-auth/) how to do that + # - url: https://github.com/hazelcast/hazelcast-mono + # branches: [master] + # start_path: docs/rest + # - url: https://github.com/hazelcast/management-center + # branches: [master] + # start_path: hazelcast-management-center/src/openapi/external + # - url: https://github.com/hazelcast/management-center + # branches: [5.1.z, 5.2.z, 5.3.0] + # start_path: openapi/external - url: https://github.com/hazelcast-guides/csharp-client-getting-started branches: master start_path: docs @@ -224,27 +225,13 @@ ui: bundle: url: https://github.com/hazelcast/hazelcast-docs-ui/releases/latest/download/ui-bundle.zip snapshot: true - supplemental_files: - - path: netlify.toml - contents: > - [[headers]] - - - - - for = "/api/*" - [headers.values] - Access-Control-Allow-Origin = "*" - - path: ui.yml - contents: | - static_files: [ netlify.toml ] antora: extensions: - require: '@djencks/antora-aggregate-collector' trace: true componentversions: - name: hazelcast - version: '6.0-snapshot' + version: '5.5-snapshot' mappings: - module: maintain-cluster family: attachment @@ -255,35 +242,8 @@ antora: branch: includes: - 'master' - - require: '@djencks/antora-aggregate-collector' - trace: true - componentversions: - - name: hazelcast - version: '5.5' - mappings: - - module: maintain-cluster - family: attachment - origin: - url: - include: - - '**/hazelcast/hazelcast-mono' - branch: - includes: - - '5.5.0' - - name: management-center - version: '6.0-snapshot' - mappings: - - module: integrate - family: attachment - origin: - url: - include: - - '**/hazelcast/management-center' - branch: - includes: - - 'master' - name: management-center - version: '5.5' + version: '5.5-snapshot' mappings: - module: integrate family: attachment @@ -293,7 +253,7 @@ antora: - '**/hazelcast/management-center' branch: includes: - - '5.5.0' + - 'master' - name: management-center version: '5.3' mappings: @@ -342,6 +302,18 @@ antora: branch: includes: - '5.4.0' + - name: management-center + version: "5.5" + mappings: + - module: integrate + family: attachment + origin: + url: + include: + - '**/hazelcast/management-center' + branch: + includes: + - 5.5.0 - require: ./lib/api_json.js tags: - Favorites @@ -391,4 +363,3 @@ asciidoc: extensions: - ./lib/tabs-block.js - ./lib/swagger-ui-block-macro.js - - asciidoctor-kroki From 9228d98b0cf8f678ed5e93aa6a10b0eab4102e7d Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Tue, 1 Oct 2024 17:18:38 +0300 Subject: [PATCH 3/5] add comments to build config --- antora-playbook.yml | 93 +++++++++++++++++++++++++++++++-------------- 1 file changed, 65 insertions(+), 28 deletions(-) diff --git a/antora-playbook.yml b/antora-playbook.yml index 4edef396..5fdd9ba1 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,12 +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: http:localhost:3000 + 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: 'ad664bf0-07e2-42e7-9150-2e1b04b15cca' +urls: + # https://docs.antora.org/antora/latest/playbook/urls-html-extension-style/ + html_extension_style: drop content: sources: - url: . @@ -191,18 +197,15 @@ content: - url: https://github.com/hazelcast-guides/serverless-trade-monitor-dashboard branches: master start_path: docs - # Uncomment to build Swagger docs locally - # These are private repos. You need to do private repository authentication. - # See [here](https://docs.antora.org/antora/latest/playbook/private-repository-auth/) how to do that - # - url: https://github.com/hazelcast/hazelcast-mono - # branches: [master] - # start_path: docs/rest - # - url: https://github.com/hazelcast/management-center - # branches: [master] - # start_path: hazelcast-management-center/src/openapi/external - # - url: https://github.com/hazelcast/management-center - # branches: [5.1.z, 5.2.z, 5.3.0] - # start_path: openapi/external + - url: https://github.com/hazelcast/hazelcast-mono + branches: [master, 5.5.z] + start_path: docs/rest + - url: https://github.com/hazelcast/management-center + branches: [master, 5.4.0, 5.5.0] + start_path: hazelcast-management-center/src/openapi/external + - url: https://github.com/hazelcast/management-center + branches: [5.1.z, 5.2.z, 5.3.0] + start_path: openapi/external - url: https://github.com/hazelcast-guides/csharp-client-getting-started branches: master start_path: docs @@ -224,14 +227,28 @@ 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 = "*" + - path: ui.yml + contents: | + static_files: [ netlify.toml ] antora: extensions: - require: '@djencks/antora-aggregate-collector' trace: true componentversions: - name: hazelcast - version: '5.5-snapshot' + version: '6.0-snapshot' mappings: - module: maintain-cluster family: attachment @@ -242,8 +259,23 @@ antora: branch: includes: - 'master' + - require: '@djencks/antora-aggregate-collector' + trace: true + componentversions: + - name: hazelcast + version: '5.5' + mappings: + - module: maintain-cluster + family: attachment + origin: + url: + include: + - '**/hazelcast/hazelcast-mono' + branch: + includes: + - '5.5.z' - name: management-center - version: '5.5-snapshot' + version: '5.6-snapshot' mappings: - module: integrate family: attachment @@ -255,7 +287,7 @@ antora: includes: - 'master' - name: management-center - version: '5.3' + version: '5.5' mappings: - module: integrate family: attachment @@ -265,9 +297,9 @@ antora: - '**/hazelcast/management-center' branch: includes: - - '5.3.0' + - '5.5.0' - name: management-center - version: '5.2' + version: '5.3' mappings: - module: integrate family: attachment @@ -277,9 +309,9 @@ antora: - '**/hazelcast/management-center' branch: includes: - - '5.2.z' + - '5.3.0' - name: management-center - version: '5.1' + version: '5.2' mappings: - module: integrate family: attachment @@ -289,9 +321,9 @@ antora: - '**/hazelcast/management-center' branch: includes: - - '5.1.z' + - '5.2.z' - name: management-center - version: '5.4' + version: '5.1' mappings: - module: integrate family: attachment @@ -299,11 +331,11 @@ antora: url: include: - '**/hazelcast/management-center' - branch: - includes: - - '5.4.0' + branch: + includes: + - '5.1.z' - name: management-center - version: "5.5" + version: '5.4' mappings: - module: integrate family: attachment @@ -313,7 +345,8 @@ antora: - '**/hazelcast/management-center' branch: includes: - - 5.5.0 + - '5.4.0' + # Needed for API calls from Cloud Web App (Learning Centre page) - require: ./lib/api_json.js tags: - Favorites @@ -344,9 +377,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 @@ -363,3 +399,4 @@ asciidoc: extensions: - ./lib/tabs-block.js - ./lib/swagger-ui-block-macro.js +# - asciidoctor-kroki From 7ce23113d7e1aaa3441ca6fcc6bf90aca32d1e34 Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Tue, 1 Oct 2024 17:22:34 +0300 Subject: [PATCH 4/5] add comments to build config --- antora-playbook.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/antora-playbook.yml b/antora-playbook.yml index 5fdd9ba1..fff20ced 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -198,7 +198,7 @@ content: branches: master start_path: docs - url: https://github.com/hazelcast/hazelcast-mono - branches: [master, 5.5.z] + branches: [master, 5.5.0] start_path: docs/rest - url: https://github.com/hazelcast/management-center branches: [master, 5.4.0, 5.5.0] @@ -273,9 +273,9 @@ antora: - '**/hazelcast/hazelcast-mono' branch: includes: - - '5.5.z' + - '5.5.0' - name: management-center - version: '5.6-snapshot' + version: '6.0-snapshot' mappings: - module: integrate family: attachment From 003b7471da08653ce74aef954e576c64dfa77653 Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Thu, 3 Oct 2024 11:51:37 +0300 Subject: [PATCH 5/5] revert kroki --- antora-playbook-local.yml | 1 + antora-playbook.yml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/antora-playbook-local.yml b/antora-playbook-local.yml index 4edef396..75c4e1b9 100644 --- a/antora-playbook-local.yml +++ b/antora-playbook-local.yml @@ -363,3 +363,4 @@ asciidoc: extensions: - ./lib/tabs-block.js - ./lib/swagger-ui-block-macro.js + - asciidoctor-kroki diff --git a/antora-playbook.yml b/antora-playbook.yml index fff20ced..dbd67bda 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -399,4 +399,4 @@ asciidoc: extensions: - ./lib/tabs-block.js - ./lib/swagger-ui-block-macro.js -# - asciidoctor-kroki + - asciidoctor-kroki