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 4e21dc7 docs: Documented how to add a presentation to the website
chore: Added the Working-Group presentation to the website.
4e21dc7 is described below
commit 4e21dc7222b9af0ccccc934f27a5a626a9ec3ae6
Author: Christofer Dutz <[email protected]>
AuthorDate: Wed Sep 11 18:07:53 2024 +0200
docs: Documented how to add a presentation to the website
chore: Added the Working-Group presentation to the website.
---
HOWTO.md | 40 ++++++++++++++++++++---------
content/Apache/ComDev/WorkingGroups/pom.xml | 7 +++--
site/pom.xml | 13 ++++++++++
site/src/site/site.xml | 1 +
4 files changed, 45 insertions(+), 16 deletions(-)
diff --git a/HOWTO.md b/HOWTO.md
index 6f40352..4249363 100644
--- a/HOWTO.md
+++ b/HOWTO.md
@@ -17,26 +17,22 @@ And then run:
This will give you a list of questions to answer in order to create the
new presentation:
- Define value for property 'groupID': org.apache.training.presentations
- Define value for property 'artifactID': HowToDoStuff
- Define value for property 'version' 1.0-SNAPSHOT: :
+ Define value for property 'groupID': org.apache.training.content
+ Define value for property 'artifactID': training-content-HowToDoStuff
+ Define value for property 'version' 1.0.0-SNAPSHOT: :
Define value for property 'package' org.apache: :
Confirm properties configuration:
apacheTrainingToolsVersion: 1.3.0-SNAPSHOT
- groupID: org.apache.training.presentations
- artifactId: HowToDoStuff
- version 1.0-SNAPSHOT
+ groupID: org.apache.training.content
+ artifactId: training-content-HowToDoStuff
+ version 1.0.0-SNAPSHOT
package: org.apache
Y: :
-In practice you'll have to answer the first two questions (`groupID` and
+In practice, you'll have to answer the first two questions (`groupID` and
`articactID`) and just hit enter for the others. Answer Y at the end to
start the generation process.
-Once this completes, you'll have the starter presentation. You may need
-to copy the directory `src/theme` from another presentation to get the
-starter CSS file(s).
-
Update the file `pom.xml` to set the presentation's name and
description.
@@ -44,6 +40,26 @@ Edit your content in the file `src/main/asciidoc/index.adoc`
to create
your content.
Rebuild your presentation by going to the top level directory of the
-repository and running `mvn install`.
+repository and running `mvn package`.
+
+## Adding your presentation to the Apache Training (incubating) Website
+
+The website of the Apache Training project is built by the module in the
directory `site`.
+
+There are two steps that need to be done here, in order to deploy your
presentation:
+
+- Add the maven coordinates of your presentation to the `pom.xml` in two
locations:
+ - As a `dependency` (This ensures maven builds the presentation before
trying to use it)
+ - As an `artifactItem` inside the `copy-presentations` section (This tells
maven to take the war of the presentation module and to unpack it into the
output of the website module)
+
+Please be sure to pay attention to the `outputDirectory` element of the
`artifactItem`, as this defines where maven will copy the resources. In
general, following the naming of the other presentations, that somewhat reflect
the directory structure of the modules, makes sense.
+
+Now your presentation would be available on the page, but not yet added to the
navigation menu.
+In order to add it to that, you need to do one last step:
+
+- Edit the file `src/site/site.xml` and add an `item` element to the correct
place.
+Simply follow the convention of the other presentations and be sure to use the
correct path.
+As soon as you commit and push your changes, Jenkins will checkout these
changes, build your and all other presentations and then update the website.
+There should be no other step needed.
diff --git a/content/Apache/ComDev/WorkingGroups/pom.xml
b/content/Apache/ComDev/WorkingGroups/pom.xml
index b335fc3..06176a2 100644
--- a/content/Apache/ComDev/WorkingGroups/pom.xml
+++ b/content/Apache/ComDev/WorkingGroups/pom.xml
@@ -28,10 +28,9 @@
<relativePath>../../../../tools/content-parent-pom/pom.xml</relativePath>
</parent>
- <artifactId>WorkingGroups</artifactId>
-
- <groupId>org.apache</groupId>
- <version>1.0-SNAPSHOT</version>
+ <groupId>org.apache.training.content</groupId>
+ <artifactId>training-content-apache-comdev-working-groups</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
<packaging>war</packaging>
<name>Training: Content: Apache: ComDev: Working Groups</name>
diff --git a/site/pom.xml b/site/pom.xml
index 019c7e2..a3f16a2 100644
--- a/site/pom.xml
+++ b/site/pom.xml
@@ -242,6 +242,13 @@
<type>war</type>
<outputDirectory>${project.build.directory}/site/presentations/comdev/comdev-intro</outputDirectory>
</artifactItem>
+ <artifactItem>
+ <groupId>org.apache.training.content</groupId>
+
<artifactId>training-content-apache-comdev-working-groups</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <type>war</type>
+
<outputDirectory>${project.build.directory}/site/presentations/comdev/working-groups</outputDirectory>
+ </artifactItem>
<artifactItem>
<groupId>org.apache.training.content</groupId>
<artifactId>training-content-apache-druid</artifactId>
@@ -583,6 +590,12 @@
<version>1.0.0-SNAPSHOT</version>
<type>war</type>
</dependency>
+ <dependency>
+ <groupId>org.apache.training.content</groupId>
+ <artifactId>training-content-apache-comdev-working-groups</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <type>war</type>
+ </dependency>
<dependency>
<groupId>org.apache.training.content</groupId>
<artifactId>training-content-apache-druid</artifactId>
diff --git a/site/src/site/site.xml b/site/src/site/site.xml
index f2fc7ec..1a36f42 100644
--- a/site/src/site/site.xml
+++ b/site/src/site/site.xml
@@ -113,6 +113,7 @@
<item name="Apache ComDev">
<item name="The ASF"
href="presentations/comdev/apache-intro/index.html" target="_blank"/>
<item name="Intro" href="presentations/comdev/comdev-intro/index.html"
target="_blank"/>
+ <item name="Working Groups"
href="presentations/comdev/working-groups/index.html" target="_blank"/>
</item>
<item name="Apache Druid" href="presentations/druid/index.html"
target="_blank"/>
<item name="Apache Flink" href="presentations/flink/index.html"
target="_blank"/>
