Skip to content

Commit 932d420

Browse files
authored
DOCS-173 Update structure for new tutorials subsite (#58)
* DOCS-173 Update structure for new tutorials subsite * Add build hook * Change to IMDG * Update script with new paths
1 parent 6d0e3c4 commit 932d420

File tree

9 files changed

+35
-60
lines changed

9 files changed

+35
-60
lines changed

.github/workflows/build-site.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# This workflow takes the contents of the branches/tags and builds the production documentation site
2+
name: Build production site
3+
4+
on:
5+
push:
6+
branches: [master]
7+
8+
jobs:
9+
dispatch:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Trigger build
13+
run: curl -X POST -d {} https://api.netlify.com/build_hooks/6238ac2881e6d20c7db8e6c8

.github/workflows/build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ name: build
22
on:
33
push:
44
paths-ignore:
5-
- 'doc/**'
5+
- 'docs/**'
66
pull_request:
77
paths-ignore:
8-
- 'doc/**'
8+
- 'docs/**'
99

1010
jobs:
1111
build:

.github/workflows/guide-website-update.yml

Lines changed: 0 additions & 37 deletions
This file was deleted.

README.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
See the link:https://docs.hazelcast.com/tutorials/caching-springboot[tutorial].

README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

create.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
asciidoctor -a allow-uri-read *.adoc;
2-
asciidoctor-pdf -a allow-uri-read *.adoc;
1+
asciidoctor -D . -a allow-uri-read docs/modules/ROOT/pages/*.adoc;
2+
asciidoctor-pdf -D . -a allow-uri-read docs/modules/ROOT/pages/*.adoc;

doc/antora.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/antora.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
name: tutorials
2+
version: ~

doc/modules/ROOT/pages/index.adoc renamed to docs/modules/ROOT/pages/caching-springboot.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
:github-address: https://github.com/hazelcast-guides/caching-springboot
2-
:hazelcast: Hazelcast IMDG
1+
= Cache with Spring Boot and Hazelcast
32
:templates-url: templates:ROOT:page$/
3+
:page-layout: tutorial
4+
:page-product: imdg
5+
:page-categories: Caching, Spring Boot
6+
:page-lang: java
7+
:page-edition:
8+
:page-est-time: 5 mins
49
:framework: Spring Boot
5-
= Caching with Spring Boot and Hazelcast
6-
7-
This guide will get you started to use Hazelcast as a cache manager for your Spring Boot application.
8-
9-
include::{templates-url}/link-to-repo.adoc[]
10+
:description: In this tutorial, you'll deploy a Spring Boot application that uses Hazelcast as a cache manager.
1011

1112
== What You’ll Learn
1213

13-
In this guide, you'll deploy a Spring Boot application that uses Hazelcast as a cache manager.
14+
{description}
1415

15-
== Prerequisites
16+
== Before you Begin
1617

17-
- ~5 minutes
1818
- JDK 1.8+
1919
- Apache Maven 3.2+
2020

@@ -77,7 +77,7 @@ If we started the application, then every call to the endpoint `/books/<isbn>` w
7777

7878
Only if it does not find value in the cache, the method `findBookInSlowSource()` would be executed.
7979

80-
== Using Hazelcast as Cache Manager
80+
== Use Hazelcast as Cache Manager
8181

8282
We want to use Hazelcast as the cache manager. The good news is that all you have to do it to add Hazelcast to your classpath.
8383

@@ -109,7 +109,7 @@ hazelcast:
109109

110110
No more configuration needed, Hazelcast is already used as the cache manager for your project!
111111

112-
== Starting the Application
112+
== Start the Application
113113

114114
To start the application, run the following command:
115115

@@ -125,7 +125,7 @@ Members {size:1, ver:1} [
125125
]
126126
----
127127

128-
== Testing the Application
128+
== Test the Application
129129

130130
You can test the application by executing the following command:
131131

@@ -141,8 +141,8 @@ curl localhost:8080/books/12345
141141
Sample Book Name
142142
----
143143

144-
== What's more?
144+
== See Also
145145

146-
If you want to use Hazelcast in the client-server topology, then it's enough to place `hazelcast-client.yaml` file instead of `hazelcast.yaml` on your classpath. And that's it! You configured a Hazelcast client.
146+
If you want to use Hazelcast in the client/server topology, then it's enough to place `hazelcast-client.yaml` file instead of `hazelcast.yaml` on your classpath. And that's it! You configured a Hazelcast client.
147147

148148
If you want to read more, check out the official documentation https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-hazelcast[Spring Boot: Hazelcast].

0 commit comments

Comments
 (0)