This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-training.git
The following commit(s) were added to refs/heads/develop by this push:
new 6bad87c chore(site): Updated the "getting started" documentation to
actually work and added a section on how to use the latest SNAPSHOT versions.
Also renamed the menu-entry on how to build to how to build the website, as
this is what it's actually about.
6bad87c is described below
commit 6bad87c8830cf425fc76953f11fb4c131064ab79
Author: cdutz <[email protected]>
AuthorDate: Wed Apr 6 11:01:12 2022 +0200
chore(site): Updated the "getting started" documentation to actually work
and added a section on how to use the latest SNAPSHOT versions. Also renamed
the menu-entry on how to build to how to build the website, as this is what
it's actually about.
---
.../{building.adoc => building-website.adoc} | 0
site/src/site/asciidoc/users/index.adoc | 28 ++++++++++++++++++++--
site/src/site/site.xml | 2 +-
3 files changed, 27 insertions(+), 3 deletions(-)
diff --git a/site/src/site/asciidoc/developers/building.adoc
b/site/src/site/asciidoc/developers/building-website.adoc
similarity index 100%
rename from site/src/site/asciidoc/developers/building.adoc
rename to site/src/site/asciidoc/developers/building-website.adoc
diff --git a/site/src/site/asciidoc/users/index.adoc
b/site/src/site/asciidoc/users/index.adoc
index 7934580..a85c8c5 100644
--- a/site/src/site/asciidoc/users/index.adoc
+++ b/site/src/site/asciidoc/users/index.adoc
@@ -32,11 +32,11 @@ 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 archetype:generate -DarchetypeGroupId=org.apache.training
-DarchetypeArtifactId=content-archetype -DarchetypeVersion=1.1.0-SNAPSHOT
+ mvn archetype:generate -DarchetypeGroupId=org.apache.training
-DarchetypeArtifactId=content-archetype -DarchetypeVersion=1.0.0
For Windows, you need to wrap every argument in double-quotes:
- mvn archetype:generate "-DarchetypeGroupId=org.apache.training"
"-DarchetypeArtifactId=content-archetype" "-DarchetypeVersion=1.1.0-SNAPSHOT"
+ mvn archetype:generate "-DarchetypeGroupId=org.apache.training"
"-DarchetypeArtifactId=content-archetype" "-DarchetypeVersion=1.0.0"
After choosing `groupId`, `artifactId`, `version` and `package` there should
be a new directory that matches the `artifactId` that you selected.
@@ -48,6 +48,30 @@ 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.
+== Using the latest development version
+
+If you want to use the latest development version of the Apache Training
tooling, please still use the latest released archetype. Otherwise, the
archetype plugin will not be able to find the `SNAPSHOT` version of the
archetype. As generally most changes apply to the parent being used in the
slides module, you can update to the latest version by:
+
+Adding the following section to the generated `pom.xml`:
+
+```
+ <!-- Make Snapshots of Apache projects available -->
+ <repositories>
+ <repository>
+ <id>apache-snapshots</id>
+ <url>https://repository.apache.org/content/repositories/snapshots</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+```
+
+After adding this you can update the parent version to the latest `SNAPSHOT`
version and Maven should be able to find it.
+
== Building the Apache Training Tooling
Additional requirements:
diff --git a/site/src/site/site.xml b/site/src/site/site.xml
index 2b47018..92e6f1e 100644
--- a/site/src/site/site.xml
+++ b/site/src/site/site.xml
@@ -104,7 +104,7 @@
</menu>
<menu name="Developers">
<item name="Bug & Issue Tracker" href="developers/issues.html"/>
- <item name="Building Training" href="developers/building.html"/>
+ <item name="Building Training Website"
href="developers/building-website.html"/>
<item name="Continuous Integration" href="developers/ci.html"/>
<item name="Contributing" href="developers/contributing.html"/>
<item name="Decision Making" href="developers/decisions.html"/>
