From 1784f6e73ca1d0c0235db87d83a17c9f57543875 Mon Sep 17 00:00:00 2001 From: Oliver Howell Date: Mon, 21 Oct 2024 14:29:23 +0100 Subject: [PATCH 1/4] Merge develop into main (#399) 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 --- antora-playbook-local.yml | 7 +-- antora-playbook.yml | 7 +-- search-config.json | 16 ++++++- 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 +++++++++++++++++++ 8 files changed, 93 insertions(+), 8 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..e83e635c 100644 --- a/antora-playbook-local.yml +++ b/antora-playbook-local.yml @@ -10,11 +10,14 @@ 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/*] start_path: docs + - url: https://github.com/hazelcast/hz-flow-docs + branches: [main] + start_path: docs - url: https://github.com/hazelcast/imdg-docs branches: [v/*] start_path: docs @@ -78,8 +81,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..64a57e88 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -12,11 +12,14 @@ 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/*] start_path: docs + - url: https://github.com/hazelcast/hz-flow-docs + branches: [main] + start_path: docs - url: https://github.com/hazelcast/imdg-docs branches: [v/*] start_path: docs @@ -80,8 +83,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/search-config.json b/search-config.json index 1ae0156b..6f0c6f7c 100644 --- a/search-config.json +++ b/search-config.json @@ -8,6 +8,18 @@ ], "selectors_key": "tutorials" }, + { + "url": "https://docs.hazelcast.com/flow/(?P.*?)", + "tags": [ + "flow" + ], + "variables": { + "version": [ + "5.5" + ] + }, + "selectors_key": "flow" + }, { "url": "https://docs.hazelcast.com/imdg/(?P.*?)/", "tags": [ @@ -162,11 +174,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" 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 f2a6dc9d9a070893f338a8b80663fb9ab09e3265 Mon Sep 17 00:00:00 2001 From: devOpsHelm <54980549+devOpsHelm@users.noreply.github.com> Date: Mon, 21 Oct 2024 16:03:00 +0200 Subject: [PATCH 2/4] Platform operator for Kubernetes (5.14) (#402) Signed-off-by: devOpsHelm --- _redirects | 2 +- search-config.json | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/_redirects b/_redirects index db080678..69f5531c 100644 --- a/_redirects +++ b/_redirects @@ -17,7 +17,7 @@ /hazelcast/latest-dev/* /hazelcast/6.0-snapshot/:splat 200! # Redirect latest operator alias to the latest version -/operator/latest/* /operator/5.13/:splat 200! +/operator/latest/* /operator/5.14/:splat 200! # Redirect latest-dev operator alias to the latest-dev version /operator/latest-dev/* /operator/latest-snapshot/:splat 200! diff --git a/search-config.json b/search-config.json index 6f0c6f7c..21079e22 100644 --- a/search-config.json +++ b/search-config.json @@ -243,6 +243,18 @@ }, "selectors_key": "command-line-client" }, + { + "url": "https://docs.hazelcast.com/operator/(?P.*?)/", + "tags": [ + "operator-5.14" + ], + "variables": { + "version": [ + "5.14" + ] + }, + "selectors_key": "operator" + }, { "url": "https://docs.hazelcast.com/operator/(?P.*?)/", "tags": [ From dc6b76f1b5fc2e616caa1236ec6e0bbc73aa923f Mon Sep 17 00:00:00 2001 From: Oliver Howell Date: Tue, 22 Oct 2024 12:31:11 +0100 Subject: [PATCH 3/4] Merge develop into main (#405) 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 | 3 +++ search-config.json | 22 +++++++++++++++++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/_redirects b/_redirects index 69f5531c..d86af141 100644 --- a/_redirects +++ b/_redirects @@ -22,6 +22,9 @@ # Redirect latest-dev operator alias to the latest-dev version /operator/latest-dev/* /operator/latest-snapshot/:splat 200! +# Redirect latest Flow alias to the latest version +/flow/latest/* /flow/5.5/:splat 200! + # Redirect latest imdg alias to the latest version /imdg/latest/* /imdg/4.2/:splat 200! diff --git a/search-config.json b/search-config.json index 21079e22..7fe83d23 100644 --- a/search-config.json +++ b/search-config.json @@ -9,9 +9,9 @@ "selectors_key": "tutorials" }, { - "url": "https://docs.hazelcast.com/flow/(?P.*?)", + "url": "https://docs.hazelcast.com/flow/(?P.*?)/", "tags": [ - "flow" + "flow-5.5" ], "variables": { "version": [ @@ -559,7 +559,23 @@ "lvl2": ".doc h2", "lvl3": ".doc h3", "text": ".doc p, .doc td.content, .doc th.tableblock" - } + }, + "flow": { + "lvl0": { + "selector": "/html[1]/body[1]/div[1]/main[1]/div[1]/article[1]/nav[1]/ul[1]/li[1]/a[1]", + "type": "xpath", + "global": true, + "default_value": "Flow" + }, + "lvl1": { + "selector": "/html[1]/body[1]/div[1]/main[1]/div[1]/article[1]/nav[1]/ul[1]/li[2]", + "type": "xpath", + "global": true + }, + "lvl2": ".doc h1", + "lvl3": ".doc h2", + "text": ".doc p, .doc td.content, .doc th.tableblock" + } }, "custom_settings": { "attributesForFaceting": [ From 8b0fb1c6ae757a2a43b38e9ba0d230cf058b1690 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Tue, 22 Oct 2024 12:37:38 +0000 Subject: [PATCH 4/4] 6.0-snapshot : update _redirects and search-config.json and antora-playbook.yml and antora-playbook-local.yml --- search-config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/search-config.json b/search-config.json index 7fe83d23..810fa0ab 100644 --- a/search-config.json +++ b/search-config.json @@ -575,7 +575,7 @@ "lvl2": ".doc h1", "lvl3": ".doc h2", "text": ".doc p, .doc td.content, .doc th.tableblock" - } + } }, "custom_settings": { "attributesForFaceting": [