This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-training.git
The following commit(s) were added to refs/heads/master by this push:
new 38fe331 - Added some documentation on how to use the new tooling to
the website - Fixed an issue causing problems when running "mvn site" on the
root of the project - Bumped the version of the apache parent on all modules to
the just recently released version 22
38fe331 is described below
commit 38fe3312852c929c950241feb840be8b1c973160
Author: Christofer Dutz <[email protected]>
AuthorDate: Fri Jan 24 10:09:00 2020 +0100
- Added some documentation on how to use the new tooling to the website
- Fixed an issue causing problems when running "mvn site" on the root of
the project
- Bumped the version of the apache parent on all modules to the just
recently released version 22
---
pom.xml | 6 +++++
site/pom.xml | 2 +-
site/src/site/asciidoc/users/index.adoc | 42 +++++++++++++++++++++++++++++++++
site/src/site/site.xml | 1 +
tools/content-archetype/pom.xml | 2 +-
tools/content-parent-pom/pom.xml | 2 +-
tools/content-parent-resources/pom.xml | 2 +-
tools/pom.xml | 7 +++++-
8 files changed, 59 insertions(+), 5 deletions(-)
diff --git a/pom.xml b/pom.xml
index 52daa21..ee0a9e4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,6 +22,12 @@
<modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>apache</artifactId>
+ <version>22</version>
+ </parent>
+
<groupId>org.apache.training</groupId>
<artifactId>training</artifactId>
<version>0.4.0-SNAPSHOT</version>
diff --git a/site/pom.xml b/site/pom.xml
index b298c73..83c4c14 100644
--- a/site/pom.xml
+++ b/site/pom.xml
@@ -25,7 +25,7 @@
<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
- <version>21</version>
+ <version>22</version>
<!-- Otherwise maven complains about the pom upstairs having different
coordinates. -->
<relativePath></relativePath>
</parent>
diff --git a/site/src/site/asciidoc/users/index.adoc
b/site/src/site/asciidoc/users/index.adoc
new file mode 100644
index 0000000..bedb923
--- /dev/null
+++ b/site/src/site/asciidoc/users/index.adoc
@@ -0,0 +1,42 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+:imagesdir: ../images/
+
+== Creating Presentation with Apache Training
+
+Currently the setup uses https://asciidoctor.org/[Asciidoctor] to write
content and builds the presentation using https://maven.apache.org/[Apache
Maven] and https://revealjs.com/#/[Reveal.JS].
+
+We have prepared everything that it should be pretty simple to get started
with creating a new presentation.
+
+Requirements:
+
+- Java 8 or newer
+- Maven 3.3 or newer
+
+In order to create an empty presentation to start with, please execute the
following command:
+
+ mvn archetype:generate -DarchetypeGroupId=org.apache.training
-DarchetypeArtifactId=content-archetype -DarchetypeVersion=1.0.0-SNAPSHOT
+
+After choosing `groupId`, `artifactId`, `version` and `package` there should
be a new directory that matches the `artifactId` that you selected.
+
+Change into this directory and run the following command to build the
presentation:
+
+ mvn package
+
+After that, there should be a directory `target/generated-slides`.
+
+If you open the `index.html` in that directory your presentation should open
in the browser.
diff --git a/site/src/site/site.xml b/site/src/site/site.xml
index e1b7603..b6ec630 100644
--- a/site/src/site/site.xml
+++ b/site/src/site/site.xml
@@ -100,6 +100,7 @@
<menu name="Users">
<item name="Downloads" href="downloads.html"/>
+ <item name="Getting Started" href="users/index.html"/>
</menu>
<menu name="Developers">
<item name="Bug & Issue Tracker" href="developers/issues.html"/>
diff --git a/tools/content-archetype/pom.xml b/tools/content-archetype/pom.xml
index 76a3a28..bae15b5 100644
--- a/tools/content-archetype/pom.xml
+++ b/tools/content-archetype/pom.xml
@@ -5,7 +5,7 @@
<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
- <version>21</version>
+ <version>22</version>
<!-- Required in our case as per
http://maven.apache.org/ref/3.0.3/maven-model/maven.html#class_parent -->
<relativePath></relativePath>
diff --git a/tools/content-parent-pom/pom.xml b/tools/content-parent-pom/pom.xml
index 58f9beb..6f60c11 100644
--- a/tools/content-parent-pom/pom.xml
+++ b/tools/content-parent-pom/pom.xml
@@ -24,7 +24,7 @@
<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
- <version>21</version>
+ <version>22</version>
<!-- Required in our case as per
http://maven.apache.org/ref/3.0.3/maven-model/maven.html#class_parent -->
<relativePath></relativePath>
diff --git a/tools/content-parent-resources/pom.xml
b/tools/content-parent-resources/pom.xml
index 85044f5..f335f6c 100644
--- a/tools/content-parent-resources/pom.xml
+++ b/tools/content-parent-resources/pom.xml
@@ -24,7 +24,7 @@
<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
- <version>21</version>
+ <version>22</version>
<!-- Required in our case as per
http://maven.apache.org/ref/3.0.3/maven-model/maven.html#class_parent -->
<relativePath></relativePath>
diff --git a/tools/pom.xml b/tools/pom.xml
index cb7dbc0..d4e8753 100644
--- a/tools/pom.xml
+++ b/tools/pom.xml
@@ -22,7 +22,12 @@
<modelVersion>4.0.0</modelVersion>
- <groupId>org.apache.training</groupId>
+ <parent>
+ <groupId>org.apache.training</groupId>
+ <artifactId>training</artifactId>
+ <version>0.4.0-SNAPSHOT</version>
+ </parent>
+
<artifactId>training-tools</artifactId>
<version>0.4.0-SNAPSHOT</version>
<packaging>pom</packaging>
