DOCS-173 Update structure for new tutorials subsite (#68)

JakeSCahill · web-flow · commit d35f8a6dff7f · 2022-06-07T14:28:59.000+03:00
* DOCS-173 Update structure for new tutorials subsite

* Add build hooks and rename file

* Add examples to unique directories

Directories are shared among all tutorials, so we must do this to avoid conflicts with duplicate files

* Recreate symlinks

* Restructure

* Restructure

* Rename file

* Update build filters

* Change to IMDG
diff --git a/.github/workflows/build-site.yml b/.github/workflows/build-site.yml
@@ -0,0 +1,13 @@
+# This workflow takes the contents of the branches/tags and builds the production documentation site
+name: Build production site
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  dispatch:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Trigger build
+      run: curl -X POST -d {} https://api.netlify.com/build_hooks/6238ac2881e6d20c7db8e6c8
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,10 +2,10 @@ name: build
 on:
   push:
     paths-ignore:
-      - 'doc/**'
+      - 'docs/**'
   pull_request:
     paths-ignore:
-      - 'doc/**'
+      - 'docs/**'
 
 jobs:
   build:
diff --git a/.github/workflows/guide-website-update.yml b/.github/workflows/guide-website-update.yml
diff --git a/README.adoc b/README.adoc
@@ -0,0 +1 @@
+See the link:https://docs.hazelcast.com/tutorials/hazelcast-embedded-springboot[tutorial].
diff --git a/README.md b/README.md
diff --git a/doc/antora.yml b/doc/antora.yml
diff --git a/doc/modules/ROOT/pages/index.adoc b/doc/modules/ROOT/pages/index.adoc
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -0,0 +1,2 @@
+name: tutorials
+version: ~
diff --git a/docs/modules/ROOT/examples/hazelcast-embedded-springboot/pom.xml b/docs/modules/ROOT/examples/hazelcast-embedded-springboot/pom.xml
@@ -0,0 +1 @@
+../../../../../pom.xml
diff --git a/docs/modules/ROOT/examples/hazelcast-embedded-springboot/src b/docs/modules/ROOT/examples/hazelcast-embedded-springboot/src
@@ -0,0 +1 @@
+../../../../../src
diff --git a/docs/modules/ROOT/pages/hazelcast-embedded-springboot.adoc b/docs/modules/ROOT/pages/hazelcast-embedded-springboot.adoc
@@ -0,0 +1,100 @@
+= Get Started with Hazelcast using Spring Boot
+:templates-url: templates:ROOT:page$/
+:page-layout: tutorial
+:page-product: imdg
+:page-categories: Caching, Getting Started, Spring Boot, Microservices
+:page-lang: java
+:page-edition: 
+:page-est-time: 15 mins
+:framework: Spring Boot
+:description: This tutorial will get you started with Hazelcast in a Spring Boot application.
+
+== What You’ll Learn
+
+{description}
+
+== Before you Begin
+
+include::{templates-url}/microservices/prerequisites.adoc[]
+
+== The Spring Boot Application Structure
+
+include::{templates-url}/microservices/application-structure.adoc[]
+
+== Use Hazelcast in the Application
+
+If Hazelcast is on the classpath and a suitable configuration is found, Spring Boot auto-configures a `HazelcastInstance` that you can inject into your application. In the `pom.xml` file, you can see Hazelcast is added as a dependency:
+
+[source,xml,indent=0]
+----
+include::ROOT:example$hazelcast-embedded-springboot/pom.xml[tag=hazelcast-dep]
+----
+
+Hazelcast configuration (`hazelcast.yaml`) is placed in the `src/main/resources/` directory. You only need to auto-wire the `HazelcastInstance` bean in the `CommandController` and use it to access to Hazelcast data structures:
+
+[source,java,indent=0]
+----
+include::ROOT:example$hazelcast-embedded-springboot/src/main/java/guides/hazelcast/springboot/CommandController.java[]
+----
+
+== Run the Sample Application
+
+Run the application using Maven in a terminal:
+
+----
+mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Dserver.port=8080"
+----
+
+Then, rerun the application in another terminal.
+
+NOTE: Notice the different value for the `server.port` argument.
+
+----
+mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Dserver.port=8081"
+----
+
+After both application instances are initialized, you should see that the Hazelcast cluster is formed:
+
+```bash
+Members {size:2, ver:2} [
+	Member [192.168.1.64]:5701 - 520aec3f-58a6-4fcb-a3c7-498dcf37d8ff
+	Member [192.168.1.64]:5702 - 5c03e467-d457-4847-b49a-745a335db557 this
+]
+```
+
+Now, you can issue HTTP requests to put and get data back. Run the following command to put the data into a Hazelcast distributed map:
+
+```bash
+curl --data "key=key1&value=hazelcast" "localhost:8080/put"
+```
+
+You will see the value in the output. Then run the command below to get the data back. Please note that the call is made to the other application instance:
+
+```bash
+curl "localhost:8081/get?key=key1"
+```
+
+Again, you will see the value in the output since the data is distributed among Hazelcast cluster instances and can be accessed from any of them.
+
+== Test the Application
+
+To run the integration tests, run the following command in terminal. But before, make sure to kill the running application instances.
+
+----
+mvn verify -Ptests
+----
+
+If the tests pass, you’ll see a similar output to the following:
+
+----
+[INFO] Results:
+[INFO]
+[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
+[INFO]
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+----
+
+== Summary
+
+In this guide, you developed a simple Spring Boot application that stores the data in a Hazelcast member. You started two application instances, and they formed a Hazelcast cluster. You pushed data to an application instance, and since the data was shared among Hazelcast cluster members, you could access it from both application instances.
diff --git a/pom.xml b/pom.xml
@@ -56,11 +56,13 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
+        <!-- tag::hazelcast-dep[] -->
         <dependency>
             <groupId>com.hazelcast</groupId>
             <artifactId>hazelcast-all</artifactId>
             <version>${hazelcast.version}</version>
         </dependency>
+        <!-- end::hazelcast-dep[] -->
 
         <dependency>
             <groupId>org.springframework.boot</groupId>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+See the link:https://docs.hazelcast.com/tutorials/hazelcast-embedded-springboot[tutorial].`