Fixes #4212 - Refactor docs to use Maven site plugin from root project (

#4228)
piranhacloud · Nov 19, 2024 · c20c9ed · c20c9ed
1 parent 1ce571c
commit c20c9ed
Show file tree

Hide file tree

Showing 67 changed files with 368 additions and 104 deletions.
diff --git a/.github/workflows/branch.yml b/.github/workflows/branch.yml
@@ -7,6 +7,35 @@ on:
       - 'v*'
   workflow_dispatch:
 jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Piranha
+      uses: actions/checkout@v4
+    - name: Checkout Piranha Website
+      uses: actions/checkout@v4
+      with:
+        repository: piranhacloud/piranha-website
+        token: ${{ secrets.GIT_PASSWORD }}
+        path: piranha-website
+        ref: 'gh-pages'
+    - name: Setup Java
+      uses: actions/setup-java@v4
+      with:
+        distribution: 'temurin'
+        java-version: 21
+    - name: Build with Maven
+      run: |
+        mvn -B -DskipTests -DskipITs -ntp -T 1 install site
+        rm -rf piranha-website/snapshot || true
+        mkdir -p piranha-website/snapshot || true
+        cp -R target/site/* piranha-website/snapshot/
+        cd piranha-website
+        git config --global user.email "[email protected]"
+        git config --global user.name "Automated publish"
+        git add .
+        git commit -a -m "Publishing SNAPSHOT documentation" || true
+        git push
   ghcr:
     if: github.repository == 'piranhacloud/piranha'
     runs-on: ubuntu-latest

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -56,8 +56,7 @@ jobs:
         java-version: 21
     - name: Build with Maven
       run: |
-        cd docs
-        mvn -B -DskipTests -DskipITs -ntp -P docs site
+        mvn -B -DskipTests -DskipITs -ntp -T 1 install site
   maven-plugin:
     needs: docs
     runs-on: ubuntu-latest

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
diff --git a/arquillian/managed/pom.xml b/arquillian/managed/pom.xml
@@ -74,4 +74,10 @@
             <artifactId>arquillian-testenricher-initialcontext</artifactId>
         </dependency>
     </dependencies>
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/arquillian/managed/</url>
+        </site>
+    </distributionManagement>   
 </project>
diff --git a/arquillian/pom.xml b/arquillian/pom.xml
@@ -13,7 +13,7 @@
     <artifactId>project</artifactId>
     <packaging>pom</packaging>
 
-    <name>Piranha - Arquillian - Project</name>
+    <name>Piranha - Arquillian</name>
     <description>
         The Piranha Arquillian Project delivers you with Arquillian support.
     </description>
@@ -52,4 +52,10 @@
             </dependency>
         </dependencies>
     </dependencyManagement>
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/arquillian/</url>
+        </site>
+    </distributionManagement>   
 </project>
diff --git a/arquillian/server/pom.xml b/arquillian/server/pom.xml
@@ -117,7 +117,12 @@
             </plugin>
         </plugins>
     </build>
-
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/arquillian/server/</url>
+        </site>
+    </distributionManagement>   
     <profiles>
         <profile>
             <id>release</id>

diff --git a/bom/pom.xml b/bom/pom.xml
@@ -226,4 +226,10 @@
             </dependency>
         </dependencies>
     </dependencyManagement>
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/bom/</url>
+        </site>
+    </distributionManagement>       
 </project>
diff --git a/core/api/pom.xml b/core/api/pom.xml
@@ -28,4 +28,11 @@
             <scope>compile</scope>
         </dependency>
     </dependencies>
+
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/core/api/</url>
+        </site>
+    </distributionManagement>       
 </project>
diff --git a/core/impl/pom.xml b/core/impl/pom.xml
@@ -62,4 +62,10 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/core/impl/</url>
+        </site>
+    </distributionManagement>       
 </project>
diff --git a/core/pom.xml b/core/pom.xml
@@ -13,7 +13,7 @@
     <artifactId>project</artifactId>
     <packaging>pom</packaging>
 
-    <name>Piranha - Core - Project</name>
+    <name>Piranha - Core</name>
 
     <modules>
         <module>api</module>
@@ -49,4 +49,11 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/core/</url>
+        </site>
+    </distributionManagement>       
 </project>
diff --git a/dist/coreprofile/pom.xml b/dist/coreprofile/pom.xml
@@ -12,7 +12,7 @@
     <artifactId>piranha-dist-coreprofile</artifactId>
     <packaging>jar</packaging>
 
-    <name>Piranha - Distribution - CoreProfile</name>
+    <name>Piranha - Distribution - Core Profile</name>
 
     <dependencies>
         <!-- compile -->
@@ -69,7 +69,12 @@
             </plugin>
         </plugins>
     </build>
-
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/coreprofile/</url>
+        </site>
+    </distributionManagement>
     <profiles>
         <profile>
             <id>docker</id>
@@ -132,4 +137,17 @@
             </build>
         </profile>
     </profiles>
+    <reporting>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-project-info-reports-plugin</artifactId>
+                <reportSets>
+                    <reportSet>
+                        <reports/>
+                    </reportSet>
+                </reportSets>
+            </plugin>
+        </plugins>
+    </reporting>
 </project>
diff --git a/...coreprofile/create_a_json_rest_service.md → ...te/markdown/create_a_json_rest_service.md b/...coreprofile/create_a_json_rest_service.md → ...te/markdown/create_a_json_rest_service.md
diff --git a/...down/coreprofile/create_a_rest_service.md → ...rc/site/markdown/create_a_rest_service.md b/...down/coreprofile/create_a_rest_service.md → ...rc/site/markdown/create_a_rest_service.md
diff --git a/...debugging_a_rest_service_with_netbeans.md → ...debugging_a_rest_service_with_netbeans.md b/...debugging_a_rest_service_with_netbeans.md → ...debugging_a_rest_service_with_netbeans.md
diff --git a/...e/debugging_a_rest_service_with_vscode.md → ...n/debugging_a_rest_service_with_vscode.md b/...e/debugging_a_rest_service_with_vscode.md → ...n/debugging_a_rest_service_with_vscode.md
diff --git a/docs/src/site/markdown/coreprofile/index.md → dist/coreprofile/src/site/markdown/index.md b/docs/src/site/markdown/coreprofile/index.md → dist/coreprofile/src/site/markdown/index.md
diff --git a/...ile/testing_with_junit5_and_arquillian.md → ...own/testing_with_junit5_and_arquillian.md b/...ile/testing_with_junit5_and_arquillian.md → ...own/testing_with_junit5_and_arquillian.md
diff --git a/...arkdown/coreprofile/using_project_crac.md → ...e/src/site/markdown/using_project_crac.md b/...arkdown/coreprofile/using_project_crac.md → ...e/src/site/markdown/using_project_crac.md
diff --git a/dist/coreprofile/src/site/site.xml b/dist/coreprofile/src/site/site.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<project 
+    xmlns="http://maven.apache.org/DECORATION/1.8.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
+    <body>
+        <menu name="Core Profile">
+            <item name="Introduction" href="index.html"/>
+            <item name="Create a REST service" href="create_a_rest_service.html"/>
+            <item name="Create a JSON REST service" href="create_a_json_rest_service.html"/>
+            <item name="Debugging a REST service with NetBeans" href="debugging_a_rest_service_with_netbeans.html"/>
+            <item name="Debugging a REST service with VSCode" href="debugging_a_rest_service_with_vscode.html"/>
+            <item name="Testing with JUnit 5 and Arquillian" href="testing_with_junit5_and_arquillian.html"/>
+            <item name="Using Project CRaC" href="using_project_crac.html"/>
+        </menu>
+    </body>
+    <custom>
+        <fluidoSkin>
+            <copyrightClass>pull-right</copyrightClass>
+            <gitHub>
+                <projectId>piranhacloud/piranha</projectId>
+                <ribbonOrientation>left-bottom</ribbonOrientation>
+                <ribbonColor>black</ribbonColor>
+            </gitHub>
+            <twitter>
+                <user>piranha_cloud</user>
+            </twitter>
+        </fluidoSkin>
+    </custom>
+    <poweredBy>
+        <logo/>
+    </poweredBy>
+    <publishDate position="right"/>
+    <skin>
+        <groupId>org.apache.maven.skins</groupId>
+        <artifactId>maven-fluido-skin</artifactId>
+        <version>2.0.0</version>
+    </skin>
+    <version position="left"/>
+</project>
diff --git a/dist/isolated/pom.xml b/dist/isolated/pom.xml
@@ -184,6 +184,13 @@
         </plugins>
     </build>
 
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/isolated/</url>
+        </site>
+    </distributionManagement>
+
     <profiles>
         <profile>
             <id>docker</id>

diff --git a/dist/micro/pom.xml b/dist/micro/pom.xml
@@ -230,6 +230,13 @@
             </plugin>
         </plugins>
     </build>
+
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/micro/</url>
+        </site>
+    </distributionManagement>
 
     <profiles>
         <profile>

diff --git a/dist/microprofile/pom.xml b/dist/microprofile/pom.xml
@@ -102,6 +102,13 @@
         </plugins>
     </build>
 
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/microprofile/</url>
+        </site>
+    </distributionManagement>
+
     <profiles>
         <profile>
             <id>docker</id>

diff --git a/dist/platform/pom.xml b/dist/platform/pom.xml
@@ -124,6 +124,13 @@
         </plugins>
     </build>
 
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/platform/</url>
+        </site>
+    </distributionManagement>
+
     <profiles>
         <profile>
             <id>docker</id>

diff --git a/dist/pom.xml b/dist/pom.xml
@@ -13,7 +13,7 @@
     <artifactId>project</artifactId>
     <packaging>pom</packaging>
 
-    <name>Piranha - Distribution - Project</name>
+    <name>Piranha - Distribution</name>
 
     <modules>
         <module>coreprofile</module>
@@ -44,4 +44,11 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/</url>
+        </site>
+    </distributionManagement>    
 </project>
diff --git a/dist/server/pom.xml b/dist/server/pom.xml
@@ -116,6 +116,13 @@
         </plugins>
     </build>
 
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/server/</url>
+        </site>
+    </distributionManagement>
+
     <profiles>
         <profile>
             <id>docker</id>

diff --git a/dist/servlet/pom.xml b/dist/servlet/pom.xml
@@ -71,6 +71,13 @@
         </plugins>
     </build>
 
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/servlet/</url>
+        </site>
+    </distributionManagement>
+
     <profiles>
         <profile>
             <id>docker</id>

diff --git a/dist/webprofile/pom.xml b/dist/webprofile/pom.xml
@@ -101,6 +101,13 @@
         </plugins>
     </build>
 
+    <distributionManagement>
+        <site>
+            <id>default</id>
+            <url>file:///tmp/piranha/dist/webprofile/</url>
+        </site>
+    </distributionManagement>
+
     <profiles>
         <profile>
             <id>docker</id>