Skip to content

Commit

Permalink
Merge branch 'hazelcast:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
fantkolja authored Oct 23, 2024
2 parents b79404a + 8b0fb1c commit 93d353b
Show file tree
Hide file tree
Showing 9 changed files with 125 additions and 9 deletions.
5 changes: 4 additions & 1 deletion _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@
/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!

# 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!

Expand Down
7 changes: 4 additions & 3 deletions antora-playbook-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
44 changes: 42 additions & 2 deletions search-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@
],
"selectors_key": "tutorials"
},
{
"url": "https://docs.hazelcast.com/flow/(?P<version>.*?)/",
"tags": [
"flow-5.5"
],
"variables": {
"version": [
"5.5"
]
},
"selectors_key": "flow"
},
{
"url": "https://docs.hazelcast.com/imdg/(?P<version>.*?)/",
"tags": [
Expand Down Expand Up @@ -162,11 +174,11 @@
{
"url": "https://docs.hazelcast.com/clc/(?P<version>.*?)/",
"tags": [
"clc-5.4.1"
"clc-5.5.0"
],
"variables": {
"version": [
"5.4.1"
"5.5.0"
]
},
"selectors_key": "command-line-client"
Expand Down Expand Up @@ -231,6 +243,18 @@
},
"selectors_key": "command-line-client"
},
{
"url": "https://docs.hazelcast.com/operator/(?P<version>.*?)/",
"tags": [
"operator-5.14"
],
"variables": {
"version": [
"5.14"
]
},
"selectors_key": "operator"
},
{
"url": "https://docs.hazelcast.com/operator/(?P<version>.*?)/",
"tags": [
Expand Down Expand Up @@ -535,6 +559,22 @@
"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": {
Expand Down
7 changes: 7 additions & 0 deletions templates/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: templates
title: Templates
version: v0.1
nav:
- modules/ROOT/nav.adoc


Original file line number Diff line number Diff line change
@@ -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::[]
3 changes: 3 additions & 0 deletions templates/modules/ROOT/pages/microservices/prerequisites.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- A text editor or IDE
- JDK 1.8+
- Apache Maven 3.2+
Original file line number Diff line number Diff line change
@@ -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::[]
46 changes: 46 additions & 0 deletions templates/modules/ROOT/pages/start-hz-cluster.adoc
Original file line number Diff line number Diff line change
@@ -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].
====

0 comments on commit 93d353b

Please sign in to comment.