Building Training Website
The Apache Training Website is built with
Apache Maven and we have tried to make the build as simple as possible.
For your convenience we also have provided a
Maven-Wrapper, that should allow building with
Java 8 or greater as a requirement.
The only requirements for building the Apache Training website should be:
Java 8 JDK (or newer)
Apache Maven (3.1.0 or newer) (Optional)
Using the Maven-Wrapper
Maven-Wrapper is used by calling the Maven-Wrapper scripts
mvnw (Mac & Linux) or
mvnw.cmd (Windows) instead of the default Maven commands
These helpers ensure Maven is available in at least the version defined in
.mvn/maven-wrapper.properties. If no suitable version can be found, it is automatically downloaded and installed alongside the project (So it doesn’t have to be downloaded every time and every project can have its own Maven version)
After the script has ensured a suitable Maven version is available, this is used and all arguments and parameters are transparently forwarded to this. So simply adding the additional
w to each of the Maven commands, there should be no difference to using a pre-installed Maven version.
This document can’t provide you with all the details needed to get started with
Maven itself. But there is a lot of good documentation out there.
Justin Mclean and Christofer Dutz even recorded a not quite 2 hour Maven training Video some time ago for another Apache project.
It should handle all the details needed to get a general understanding of Maven and how it works.
Building the Apache Training Website with Maven
The Training Website is also part of the same GIT repository that contains the code and it is built by Maven as well.
In order to build the website the following command should be sufficient:
However, this will generate the website for each module inside it’s
target/site directory. Opening this in a browser and navigating from pages of one module to another will not work as these links expect a different directory structure. In order to create a fully navigatable version of the Website, the following command should be sufficient:
mvn site site:stage
This will generate an additional
target/staging directory which contains the fully functional version.
A lot of documentation on Maven suggests to use the
site:site goal directly instead of calling the
site phase, but in case of Apache Training there is more than just the site generation that has to be executed.
This is just a quick-start version of the site generation, for fully detailed documentation please read the Website documentation page.