diff --git a/antora-playbook-local.yml b/antora-playbook-local.yml index 16898aa5..6f15f019 100644 --- a/antora-playbook-local.yml +++ b/antora-playbook-local.yml @@ -9,7 +9,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/*] @@ -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/antora-playbook.yml b/antora-playbook.yml index caeed9eb..64a57e88 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/*] @@ -83,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..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" 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]. +==== +