Skip to content

Commit 7a8a030

Browse files
committed
Initial commit
0 parents  commit 7a8a030

File tree

6 files changed

+101
-0
lines changed

6 files changed

+101
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Guide Web Site Deploy
2+
3+
on:
4+
push:
5+
branches: master
6+
paths:
7+
- 'doc/**'
8+
9+
jobs:
10+
antora:
11+
runs-on: ubuntu-18.04
12+
steps:
13+
- uses: actions/[email protected]
14+
with:
15+
repository: hazelcast-guides/guides-site
16+
ref: master
17+
token: ${{ secrets.SECRET_TOKEN }}
18+
19+
- name: Install Antora
20+
run: |
21+
sudo apt -y install curl dirmngr apt-transport-https lsb-release ca-certificates
22+
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
23+
sudo apt -y install nodejs
24+
sudo npm i -g @antora/[email protected] @antora/[email protected]
25+
- name: Build website artifacts
26+
run: |
27+
sh create.sh
28+
- name: Commit artifacts changes
29+
run: |
30+
git config --global user.name 'devOpsHazelcast'
31+
git config --global user.email '[email protected]'
32+
export GUIDE_REPO=$(cut -d/ -f2 <<<"${GITHUB_REPOSITORY}")
33+
export COMMIT_ID=$(git rev-parse --short "$GITHUB_SHA")
34+
git commit -am "${GUIDE_REPO}-${COMMIT_ID} guide update"
35+
- name: Push artifacts to guides-site repo
36+
run: git push

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
target/
2+
.idea/
3+
.settings/
4+
.classpath
5+
.directory
6+
.project
7+
.surefire-*
8+
.DS_Store
9+
*.iml
10+
*.ipr
11+
*.iws
12+
*.txt

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
See the guide [here](include published URL).

create.sh

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

doc/antora.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
name: guide-name # a brief module name. This will be included in the guide url.
2+
title: Guide Title # a brief module title. This will not show up on the website.
3+
version: master
4+

doc/modules/ROOT/pages/index.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
////
2+
This is the base template for Hazelcast integration module guides.
3+
4+
You can clone this repository, work on it and create your guide, and then push to a new repository.
5+
////
6+
7+
:github-address: [github-repo-address-of-your-guide]
8+
9+
:templates-url: https://raw.githubusercontent.com/hazelcast-guides/adoc-templates/master
10+
11+
// Use this relative url if you are going to publish the guide on the guides site.
12+
// Note that this url will not work locally and raise asciidoctor errors.
13+
// So, complete the guide with the above url and set the below one just before
14+
// publishing on the guides site.
15+
//
16+
// :templates-url: templates:ROOT:page$/
17+
18+
= Title
19+
20+
// Content entered directly below the header but before the first section heading is called the preamble.
21+
22+
include::{templates-url}/link-to-repo.adoc[]
23+
24+
== What You’ll Learn
25+
26+
// Define the problem and tell reader what he/she will learn from this guide.
27+
28+
== Prerequisites
29+
30+
// Define the prerequisites for the guide.
31+
32+
////
33+
Write the steps in your guide here by making each step a different section
34+
////
35+
36+
== Summary
37+
38+
// Provide a quick summary
39+
40+
== See Also
41+
42+
// Add some links to resources, such as other related guides.
43+
// Use relative links used on the home page (see https://raw.githubusercontent.com/hazelcast-guides/guides-site/master/home/modules/ROOT/pages/index.adoc)
44+
45+
- xref:hazelcast-embedded-springboot:ROOT:index.adoc[Hazelcast in SpringBoot]
46+
- xref:hazelcast-quarkus:ROOT:index.adoc[Hazelcast Client for Quarkus]

0 commit comments

Comments
 (0)