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 fdaef2e - Updated the documentation to work with unreleased archetypes
fdaef2e is described below
commit fdaef2e8dbeeaae1aad923830051913b4b33b68f
Author: Christofer Dutz <[email protected]>
AuthorDate: Fri Jan 24 11:06:43 2020 +0100
- Updated the documentation to work with unreleased archetypes
---
site/src/site/asciidoc/users/index.adoc | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/site/src/site/asciidoc/users/index.adoc
b/site/src/site/asciidoc/users/index.adoc
index 1cc0095..ca9e6ac 100644
--- a/site/src/site/asciidoc/users/index.adoc
+++ b/site/src/site/asciidoc/users/index.adoc
@@ -27,9 +27,12 @@ Requirements:
- Java 8 or newer
- Maven 3.3 or newer
+Until we have released the tooling, you will need to build it locally first or
the archetype plugin will fail to run.
+Please read the following chapter on how to do this.
+
In order to create an empty presentation to start with, please execute the
following command:
- mvn
-Dmaven.repo.remote=https://repository.apache.org/content/repositories/snapshots
org.apache.maven.plugins:maven-archetype-plugin:3.1.2:generate
-DarchetypeGroupId=org.apache.training -DarchetypeArtifactId=content-archetype
-DarchetypeVersion=1.0.0-SNAPSHOT
+ 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.
@@ -40,3 +43,19 @@ Change into this directory and run the following command to
build the presentati
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.
+
+== Building the Apache Training Tooling
+
+Additional requirements:
+
+- Git
+
+In order to build Apache Training Tooling, please checkout the git repo from:
+
+ git clone https://gitbox.apache.org/repos/asf/incubator-training.git
+ cd incubator-training
+ mvn install
+
+Then execute the following command:
+
+ mvn clean install
\ No newline at end of file
