Skip to content

Commit

Permalink
Move templates to the main repo (#397)
Browse files Browse the repository at this point in the history
# 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 <[email protected]>
Co-authored-by: Oliver Howell <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: GitHub Actions Bot <>
Co-authored-by: devopshazelcast <[email protected]>
Co-authored-by: devOpsHelm <[email protected]>
Co-authored-by: Nishaat Rajabali <[email protected]>
  • Loading branch information
6 people authored Oct 16, 2024
1 parent b50de08 commit 5d91734
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 6 deletions.
4 changes: 1 addition & 3 deletions antora-playbook-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/*]
Expand Down Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/*]
Expand Down Expand Up @@ -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
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 5d91734

Please sign in to comment.