From 193cc992c8cc7dc54fd846bdea51c3e3e44b730e Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Tue, 15 Oct 2024 13:35:01 +0000 Subject: [PATCH 1/4] 6.0-snapshot : update _redirects and search-config.json and antora-playbook.yml and antora-playbook-local.yml --- _redirects | 2 +- search-config.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_redirects b/_redirects index 8cb36802..e59393d2 100644 --- a/_redirects +++ b/_redirects @@ -5,7 +5,7 @@ /management-center/latest/* /management-center/5.5/:splat 200! # Redirect latest-dev management-center alias to the latest version -/management-center/latest-dev/* /management-center/5.6-snapshot/:splat 200! +/management-center/latest-dev/* /management-center/6.0-snapshot/:splat 200! # Redirect latest cloud-only management-center alias to the latest version /management-center/5.4-CLOUD-1/* /management-center/5.4-snapshot/:splat 200! diff --git a/search-config.json b/search-config.json index 272c709b..a9d7ac22 100644 --- a/search-config.json +++ b/search-config.json @@ -23,11 +23,11 @@ { "url": "https://docs.hazelcast.com/management-center/(?P.*?)/", "tags": [ - "management-center-5.6-snapshot" + "management-center-6.0-snapshot" ], "variables": { "version": [ - "5.6-snapshot" + "6.0-snapshot" ] }, "selectors_key": "mc" From b50de0887dc80967a788c393ebb597fd6a9a58b2 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Wed, 16 Oct 2024 11:10:49 +0000 Subject: [PATCH 2/4] 5.6.0 : update _redirects and search-config.json and antora-playbook.yml and antora-playbook-local.yml --- _redirects | 2 +- antora-playbook-local.yml | 12 ++++++++++++ antora-playbook.yml | 34 +++++++++++++++++++++++++++++++--- search-config.json | 12 ++++++++++++ 4 files changed, 56 insertions(+), 4 deletions(-) diff --git a/_redirects b/_redirects index e59393d2..db080678 100644 --- a/_redirects +++ b/_redirects @@ -2,7 +2,7 @@ /hazelcast /home 200! # Redirect latest management-center alias to the latest version -/management-center/latest/* /management-center/5.5/:splat 200! +/management-center/latest/* /management-center/5.6/:splat 200! # Redirect latest-dev management-center alias to the latest version /management-center/latest-dev/* /management-center/6.0-snapshot/:splat 200! diff --git a/antora-playbook-local.yml b/antora-playbook-local.yml index 75c4e1b9..4b4ae2fa 100644 --- a/antora-playbook-local.yml +++ b/antora-playbook-local.yml @@ -314,6 +314,18 @@ antora: branch: includes: - 5.5.0 + - name: management-center + version: "5.6" + mappings: + - module: integrate + family: attachment + origin: + url: + include: + - '**/hazelcast/management-center' + branch: + includes: + - 5.6.0 - require: ./lib/api_json.js tags: - Favorites diff --git a/antora-playbook.yml b/antora-playbook.yml index 23071ee1..c601a1a1 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -197,7 +197,7 @@ content: branches: [master, 5.5.z] start_path: docs/rest - url: https://github.com/hazelcast/management-center - branches: [master, 5.4.0, 5.5.0] + branches: [master, 5.4.0, 5.5.0, 5.6.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] @@ -232,6 +232,10 @@ ui: + + + + for = "/api/*" [headers.values] Access-Control-Allow-Origin = "*" @@ -255,6 +259,18 @@ antora: branch: includes: - 'master' + - name: management-center + version: "5.6" + mappings: + - module: integrate + family: attachment + origin: + url: + include: + - '**/hazelcast/management-center' + branch: + includes: + - 5.6.0 - require: '@djencks/antora-aggregate-collector' trace: true componentversions: @@ -281,7 +297,7 @@ antora: - '**/hazelcast/management-center' branch: includes: - - 'master' + - 'master' - name: management-center version: '5.5' mappings: @@ -293,7 +309,7 @@ antora: - '**/hazelcast/management-center' branch: includes: - - '5.5.0' + - '5.5.0' - name: management-center version: '5.3' mappings: @@ -342,6 +358,18 @@ antora: branch: includes: - '5.4.0' + - name: management-center + version: "5.6" + mappings: + - module: integrate + family: attachment + origin: + url: + include: + - '**/hazelcast/management-center' + branch: + includes: + - 5.6.0 - require: ./lib/api_json.js tags: - Favorites diff --git a/search-config.json b/search-config.json index a9d7ac22..1ae0156b 100644 --- a/search-config.json +++ b/search-config.json @@ -398,6 +398,18 @@ ] }, "selectors_key": "mc" + }, + { + "url": "https://docs.hazelcast.com/management-center/(?P.*?)/", + "tags": [ + "management-center-5.6" + ], + "variables": { + "version": [ + "5.6" + ] + }, + "selectors_key": "mc" } ], "sitemap_urls": [ From 5d91734e0d1c2f607fe46de0aede3f806d28aebf Mon Sep 17 00:00:00 2001 From: Mykola Fant Date: Wed, 16 Oct 2024 14:11:12 +0300 Subject: [PATCH 3/4] Move templates to the main repo (#397) # Description of change Move templates to the main repo After we merge it, we can archive https://github.com/hazelcast-guides/adoc-templates.git --------- Signed-off-by: devOpsHelm Co-authored-by: Oliver Howell Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: GitHub Actions Bot <> 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> --- antora-playbook-local.yml | 4 +- antora-playbook.yml | 4 +- templates/antora.yml | 7 +++ .../microservices/application-structure.adoc | 8 ++++ .../pages/microservices/prerequisites.adoc | 3 ++ .../microservices/what-you-will-learn.adoc | 7 +++ .../modules/ROOT/pages/start-hz-cluster.adoc | 46 +++++++++++++++++++ 7 files changed, 73 insertions(+), 6 deletions(-) create mode 100644 templates/antora.yml create mode 100644 templates/modules/ROOT/pages/microservices/application-structure.adoc create mode 100644 templates/modules/ROOT/pages/microservices/prerequisites.adoc create mode 100644 templates/modules/ROOT/pages/microservices/what-you-will-learn.adoc create mode 100644 templates/modules/ROOT/pages/start-hz-cluster.adoc diff --git a/antora-playbook-local.yml b/antora-playbook-local.yml index 4b4ae2fa..94a50c51 100644 --- a/antora-playbook-local.yml +++ b/antora-playbook-local.yml @@ -10,7 +10,7 @@ site: content: sources: - url: . - start_paths: [home, tutorials] + start_paths: [home, tutorials, templates] branches: HEAD - url: https://github.com/hazelcast/hz-docs branches: [main, v/*] @@ -78,8 +78,6 @@ 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 c601a1a1..a525aa1a 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -12,7 +12,7 @@ urls: content: sources: - url: . - start_paths: [home, tutorials] + start_paths: [home, tutorials, templates] branches: HEAD - url: https://github.com/hazelcast/hz-docs branches: [main, v/*] @@ -80,8 +80,6 @@ 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/templates/antora.yml b/templates/antora.yml new file mode 100644 index 00000000..57e08435 --- /dev/null +++ b/templates/antora.yml @@ -0,0 +1,7 @@ +name: templates +title: Templates +version: v0.1 +nav: + - modules/ROOT/nav.adoc + + diff --git a/templates/modules/ROOT/pages/microservices/application-structure.adoc b/templates/modules/ROOT/pages/microservices/application-structure.adoc new file mode 100644 index 00000000..019251bf --- /dev/null +++ b/templates/modules/ROOT/pages/microservices/application-structure.adoc @@ -0,0 +1,8 @@ +// {framework} -> The name of the microservices framework + +ifdef::framework[] +The application is a basic {framework} app having 2 endpoints defined in `CommandController`: + +- `/put` is the page where key and values can be put on a Hazelcast distributed map. It takes `key` and `value` as query parameters and returns the entry in JSON format. +- `/get` is the page where the values in the Hazelcast distributed map can be obtained by keys. It takes `key` as query parameter and returns the found entry in JSON format. +endif::[] diff --git a/templates/modules/ROOT/pages/microservices/prerequisites.adoc b/templates/modules/ROOT/pages/microservices/prerequisites.adoc new file mode 100644 index 00000000..1d0a9e8c --- /dev/null +++ b/templates/modules/ROOT/pages/microservices/prerequisites.adoc @@ -0,0 +1,3 @@ +- A text editor or IDE +- JDK 1.8+ +- Apache Maven 3.2+ \ No newline at end of file diff --git a/templates/modules/ROOT/pages/microservices/what-you-will-learn.adoc b/templates/modules/ROOT/pages/microservices/what-you-will-learn.adoc new file mode 100644 index 00000000..00b9ca69 --- /dev/null +++ b/templates/modules/ROOT/pages/microservices/what-you-will-learn.adoc @@ -0,0 +1,7 @@ +// {framework} -> The name of the microservices framework + +ifdef::framework[] +In this guide, you will learn how to use Hazelcast IMDG within {framework} microservices. + +The {framework} application contains two REST controllers which helps you to put data and read it back. The application initializes a single Hazelcast IMDG member instance which is used to keep the data. When you run the application multiple times, Hazelcast IMDG instances build a cluster and share the data. +endif::[] diff --git a/templates/modules/ROOT/pages/start-hz-cluster.adoc b/templates/modules/ROOT/pages/start-hz-cluster.adoc new file mode 100644 index 00000000..74f4e563 --- /dev/null +++ b/templates/modules/ROOT/pages/start-hz-cluster.adoc @@ -0,0 +1,46 @@ +[tabs] +==== + +Hazelcast Cloud:: ++ +-- +You can easily create a Hazelcast cluster on https://cloud.hazelcast.com[Hazelcast Cloud] with just a few clicks. See https://docs.cloud.hazelcast.com/docs/getting-started[Getting Started] documentation for details. +-- + +Docker Image:: ++ +-- +You can start members inside Docker containers. See the https://github.com/hazelcast/hazelcast-docker[documentation] for details. +[source, bash] +---- +$ docker run hazelcast/hazelcast:$HAZELCAST_VERSION +---- +-- + +Hazelcast CLI:: ++ +-- +You can start members via Hazelcast CLI. See the https://github.com/hazelcast/hazelcast-command-line[documentation] for the installation instructions and details. +[source, bash] +---- +$ hz start +---- +-- + +Download Packages:: ++ +-- +You can start members via `start` script in https://hazelcast.org/imdg/download[IMDG bundle]. +[source, bash] +---- +$ sh bin/start.sh +---- +-- +==== + +[NOTE] +==== +You can find other ways of starting Hazelcast members and forming a cluster +https://docs.hazelcast.org/docs/latest/manual/html-single/#installing-hazelcast-imdg[here]. +==== + From d41cfbcd121d0c8549e50ba7c316d10b2d9d0f61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Y=C3=BCce=20Tekol?= Date: Fri, 18 Oct 2024 18:10:23 +0300 Subject: [PATCH 4/4] Updated search config for CLC v5.5.0 (#398) # Description of change Updated search-config for CLC v5.5.0 ## Type of change Select the type of change that you're making: - [ ] Bug fix (Addresses an issue in existing content such as a typo) - [ ] Enhancement (Adds new content) ## Open Questions and Pre-Merge TODOs - [ ] Use github checklists to create a list. When an item is solved, check the box and explain the answer. --- search-config.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/search-config.json b/search-config.json index 1ae0156b..45309dba 100644 --- a/search-config.json +++ b/search-config.json @@ -162,11 +162,11 @@ { "url": "https://docs.hazelcast.com/clc/(?P.*?)/", "tags": [ - "clc-5.4.1" + "clc-5.5.0" ], "variables": { "version": [ - "5.4.1" + "5.5.0" ] }, "selectors_key": "command-line-client"