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
commit f6d0133f5be74c4c2d85c4020e7cd2dea4953a7b Author: Christofer Dutz <[email protected]> AuthorDate: Sat Aug 2 17:18:47 2025 +0200 docs: Simplified the documentation for building the site. --- site/src/site/asciidoc/developers/building-website.adoc | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/site/src/site/asciidoc/developers/building-website.adoc b/site/src/site/asciidoc/developers/building-website.adoc index df56664..13865d7 100644 --- a/site/src/site/asciidoc/developers/building-website.adoc +++ b/site/src/site/asciidoc/developers/building-website.adoc @@ -43,7 +43,7 @@ So simply adding the additional `w` to each of the Maven commands, there should 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. +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. @@ -54,18 +54,8 @@ video::167857327[vimeo,width=640,height=420] The Training Website is also part of the same GIT repository that contains the code and it is built by Maven as well. -To build the website, the following command should be sufficient: +To build the website, the following command should be enough: mvn site -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. -To create a fully navigatable version of the Website, the following command `inside the "site" module` 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 using 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 http://training.apache.org/developers/website.html[Website] documentation page.
