You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@training.apache.org by cd...@apache.org on 2025/08/02 15:19:13 UTC
(incubator-training) branch develop updated (84180e4 -> 44f851d)
This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a change to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-training.git
from 84180e4 docs: A bit more clarification on the building of the site.
new f6d0133 docs: Simplified the documentation for building the site.
new 44f851d feat: Ensured the docker build also builds the website.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docker-compose.yaml | 3 +--
site/src/site/asciidoc/developers/building-website.adoc | 14 ++------------
2 files changed, 3 insertions(+), 14 deletions(-)
(incubator-training) 02/02: feat: Ensured the docker build also builds the website.
Posted by cd...@apache.org.
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 44f851de31a29c26b648f7afd7fc9952361494e3
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Sat Aug 2 17:19:05 2025 +0200
feat: Ensured the docker build also builds the website.
---
docker-compose.yaml | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/docker-compose.yaml b/docker-compose.yaml
index c33a0a3..a99cb2e 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -17,13 +17,12 @@
# under the License.
#
-version: "3.8"
services:
builder:
build:
context: .
dockerfile: Dockerfile
- command: ["/ws/mvnw", "-e", "-Dmaven.repo.local=/ws/out/.repository", "clean", "install"]
+ command: ["/ws/mvnw", "-e", "-Dmaven.repo.local=/ws/out/.repository", "clean", "install", "site"]
volumes:
# Bind the local directory as "/ws"
- type: bind
(incubator-training) 01/02: docs: Simplified the documentation for building the site.
Posted by cd...@apache.org.
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 <ch...@c-ware.de>
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.