[MPOM-483] Make a separate module for documentation

apache · Apr 13, 2024 · 1442171 · 1442171
1 parent 30d3a1d
commit 1442171
Show file tree

Hide file tree

Showing 28 changed files with 177 additions and 134 deletions.
diff --git a/.github/workflows/maven-verify.yml b/.github/workflows/maven-verify.yml
@@ -25,3 +25,5 @@ jobs:
   build:
     name: Verify
     uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v4
+    with:
+      ff-site-goal: 'site'
diff --git a/README.md b/README.md
@@ -64,8 +64,7 @@ There are some guidelines which will make applying PRs easier for us:
 [MPOM-XXX] - Subject of the JIRA Ticket
  Optional supplemental description.
 ```
-+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
-+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken.
++ Update the [site documentation](https://maven.apache.org/pom/maven/) accordingly in `docs` and build it via `mvn site site:stage -f docs`
 + Submit a pull request to the repository in the Apache organization.
 + Update your JIRA ticket and include a link to the pull request in the ticket.
 

diff --git a/doxia-tools/site-pom.xml → docs/doxia-tools/pom.xml b/doxia-tools/site-pom.xml → docs/doxia-tools/pom.xml
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
@@ -18,28 +17,37 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
-
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
     <groupId>org.apache.maven</groupId>
-    <!-- we need to have a different gav for pom.xml and site-pom.xml -->
-    <!-- dot at the end is on purpose -->
-    <artifactId>maven-parent.</artifactId>
+    <artifactId>docs</artifactId>
     <version>42-SNAPSHOT</version>
-    <relativePath>../site-pom.xml</relativePath>
   </parent>
 
   <groupId>org.apache.maven.doxia</groupId>
-  <artifactId>doxia-tools</artifactId>
+  <artifactId>doxia-tools-docs</artifactId>
   <packaging>pom</packaging>
 
   <name>Apache Maven Doxia Tools Parent POM</name>
   <description>This project consists of a POM that contains settings that are likely to be useful to any Maven Doxia Tool that is building and releasing code with Maven.</description>
+  <url>https://maven.apache.org/pom/maven/doxia-tools</url>
+
+  <scm>
+    <url>https://github.com/apache/maven-parent/tree/${project.scm.tag}/doxia-tools</url>
+  </scm>
 
   <issueManagement>
     <system>jira</system>
     <url>https://issues.apache.org/jira/projects/MPOM</url>
   </issueManagement>
+
+  <distributionManagement>
+    <site>
+      <id>apache.website</id>
+      <url>scm:svn:https://svn.apache.org/repos/asf/maven/website/components/${maven.site.path}/doxia-tools</url>
+    </site>
+  </distributionManagement>
+
 </project>
diff --git a/doxia-tools/src/site-docs/apt/index.apt.vm → docs/doxia-tools/src/site/apt/index.apt.vm b/doxia-tools/src/site-docs/apt/index.apt.vm → docs/doxia-tools/src/site/apt/index.apt.vm
diff --git a/doxia-tools/src/site-docs/site.xml → docs/doxia-tools/src/site/site.xml b/doxia-tools/src/site-docs/site.xml → docs/doxia-tools/src/site/site.xml
@@ -34,17 +34,7 @@ under the License.
       <item name="Extensions" href="../maven-extensions/index.html"/>
       <item name="Shared Components" href="../maven-shared-components/index.html"/>
       <item name="Skins" href="../maven-skins/index.html"/>
-      <item name="Doxia Tools" href="../doxia-tools/index.html"/>
-    </menu>
-
-    <menu ref="reports" />
-
-    <menu name="ASF">
-      <item name="How Apache Works"  href="https://www.apache.org/foundation/how-it-works.html"/>
-      <item name="Foundation"        href="https://www.apache.org/foundation/"/>
-      <item name="Data Privacy"      href="https://privacy.apache.org/policies/privacy-policy-public.html"/>
-      <item name="Sponsoring Apache" href="https://www.apache.org/foundation/sponsorship.html"/>
-      <item name="Thanks"            href="https://www.apache.org/foundation/thanks.html"/>
+      <item name="Doxia Tools" href="index.html"/>
     </menu>
 
   </body>

diff --git a/maven-extensions/site-pom.xml → docs/maven-extensions/pom.xml b/maven-extensions/site-pom.xml → docs/maven-extensions/pom.xml
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
@@ -18,29 +17,37 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
-
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
     <groupId>org.apache.maven</groupId>
-    <!-- we need to have a different gav for pom.xml and site-pom.xml -->
-    <!-- dot at the end is on purpose -->
-    <artifactId>maven-parent.</artifactId>
+    <artifactId>docs</artifactId>
     <version>42-SNAPSHOT</version>
-    <relativePath>../site-pom.xml</relativePath>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>
-  <artifactId>maven-extensions</artifactId>
+  <artifactId>maven-extensions-docs</artifactId>
   <packaging>pom</packaging>
 
   <name>Apache Maven Extensions Parent POM</name>
   <description>This project consists of a POM that contains settings that are likely to be useful to any Maven extension that is building and releasing code with Maven.</description>
+  <url>https://maven.apache.org/pom/maven/maven-extensions</url>
+
+  <scm>
+    <url>https://github.com/apache/maven-parent/tree/${project.scm.tag}/maven-extensions</url>
+  </scm>
 
   <issueManagement>
     <system>jira</system>
     <url>https://issues.apache.org/jira/projects/MPOM</url>
   </issueManagement>
+
+  <distributionManagement>
+    <site>
+      <id>apache.website</id>
+      <url>scm:svn:https://svn.apache.org/repos/asf/maven/website/components/${maven.site.path}/maven-extensions</url>
+    </site>
+  </distributionManagement>
+
 </project>
diff --git a/...extensions/src/site-docs/apt/index.apt.vm → ...aven-extensions/src/site/apt/index.apt.vm b/...extensions/src/site-docs/apt/index.apt.vm → ...aven-extensions/src/site/apt/index.apt.vm
diff --git a/maven-extensions/src/site-docs/site.xml → docs/maven-extensions/src/site/site.xml b/maven-extensions/src/site-docs/site.xml → docs/maven-extensions/src/site/site.xml
@@ -31,20 +31,11 @@ under the License.
     <menu name="Maven Parent POMs">
       <item name="Maven" href="../index.html"/>
       <item name="Plugins" href="../maven-plugins/index.html"/>
-      <item name="Extensions" href="../maven-extensions/index.html"/>
+      <item name="Extensions" href="index.html"/>
       <item name="Shared Components" href="../maven-shared-components/index.html"/>
       <item name="Skins" href="../maven-skins/index.html"/>
       <item name="Doxia Tools" href="../doxia-tools/index.html"/>
     </menu>
 
-    <menu ref="reports" />
-
-    <menu name="ASF">
-      <item name="How Apache Works"  href="https://www.apache.org/foundation/how-it-works.html"/>
-      <item name="Foundation"        href="https://www.apache.org/foundation/"/>
-      <item name="Data Privacy"      href="https://privacy.apache.org/policies/privacy-policy-public.html"/>
-      <item name="Sponsoring Apache" href="https://www.apache.org/foundation/sponsorship.html"/>
-      <item name="Thanks"            href="https://www.apache.org/foundation/thanks.html"/>
-    </menu>
   </body>
 </project>
diff --git a/maven-plugins/site-pom.xml → docs/maven-plugins/pom.xml b/maven-plugins/site-pom.xml → docs/maven-plugins/pom.xml
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
@@ -18,29 +17,37 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
-
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
     <groupId>org.apache.maven</groupId>
-    <!-- we need to have a different gav for pom.xml and site-pom.xml -->
-    <!-- dot at the end is on purpose -->
-    <artifactId>maven-parent.</artifactId>
+    <artifactId>docs</artifactId>
     <version>42-SNAPSHOT</version>
-    <relativePath>../site-pom.xml</relativePath>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>
-  <artifactId>maven-plugins</artifactId>
+  <artifactId>maven-plugins-docs</artifactId>
   <packaging>pom</packaging>
 
   <name>Apache Maven Plugins Parent POM</name>
   <description>This project consists of a POM that contains settings that are likely to be useful to any Maven plugin that is building and releasing code with Maven.</description>
+  <url>https://maven.apache.org/pom/maven/maven-plugins</url>
+
+  <scm>
+    <url>https://github.com/apache/maven-parent/tree/${project.scm.tag}/maven-plugins</url>
+  </scm>
 
   <issueManagement>
     <system>jira</system>
     <url>https://issues.apache.org/jira/projects/MPOM</url>
   </issueManagement>
+
+  <distributionManagement>
+    <site>
+      <id>apache.website</id>
+      <url>scm:svn:https://svn.apache.org/repos/asf/maven/website/components/${maven.site.path}/maven-plugins</url>
+    </site>
+  </distributionManagement>
+
 </project>
diff --git a/maven-plugins/src/site-docs/apt/index.apt.vm → docs/maven-plugins/src/site/apt/index.apt.vm b/maven-plugins/src/site-docs/apt/index.apt.vm → docs/maven-plugins/src/site/apt/index.apt.vm
diff --git a/maven-plugins/src/site-docs/site.xml → docs/maven-plugins/src/site/site.xml b/maven-plugins/src/site-docs/site.xml → docs/maven-plugins/src/site/site.xml
@@ -30,21 +30,12 @@ under the License.
 
     <menu name="Maven Parent POMs">
       <item name="Maven" href="../index.html"/>
-      <item name="Plugins" href="../maven-plugins/index.html"/>
+      <item name="Plugins" href="index.html"/>
       <item name="Extensions" href="../maven-extensions/index.html"/>
       <item name="Shared Components" href="../maven-shared-components/index.html"/>
       <item name="Skins" href="../maven-skins/index.html"/>
       <item name="Doxia Tools" href="../doxia-tools/index.html"/>
     </menu>
 
-    <menu ref="reports" />
-
-    <menu name="ASF">
-      <item name="How Apache Works"  href="https://www.apache.org/foundation/how-it-works.html"/>
-      <item name="Foundation"        href="https://www.apache.org/foundation/"/>
-      <item name="Data Privacy"      href="https://privacy.apache.org/policies/privacy-policy-public.html"/>
-      <item name="Sponsoring Apache" href="https://www.apache.org/foundation/sponsorship.html"/>
-      <item name="Thanks"            href="https://www.apache.org/foundation/thanks.html"/>
-    </menu>
   </body>
 </project>
diff --git a/maven-shared-components/site-pom.xml → docs/maven-shared-components/pom.xml b/maven-shared-components/site-pom.xml → docs/maven-shared-components/pom.xml
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
@@ -18,29 +17,37 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
-
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
     <groupId>org.apache.maven</groupId>
-    <!-- we need to have a different gav for pom.xml and site-pom.xml -->
-    <!-- dot at the end is on purpose -->
-    <artifactId>maven-parent.</artifactId>
+    <artifactId>docs</artifactId>
     <version>42-SNAPSHOT</version>
-    <relativePath>../site-pom.xml</relativePath>
   </parent>
 
   <groupId>org.apache.maven.shared</groupId>
-  <artifactId>maven-shared-components</artifactId>
+  <artifactId>maven-shared-components-docs</artifactId>
   <packaging>pom</packaging>
 
   <name>Apache Maven Shared Components Parent POM</name>
   <description>This project consists of a POM that contains settings that are likely to be useful to any Maven Shared Component that is building and releasing code with Maven.</description>
+  <url>https://maven.apache.org/pom/maven/maven-shared-components</url>
+
+  <scm>
+    <url>https://github.com/apache/maven-parent/tree/${project.scm.tag}/maven-shared-components</url>
+  </scm>
 
   <issueManagement>
     <system>jira</system>
     <url>https://issues.apache.org/jira/projects/MPOM</url>
   </issueManagement>
+
+  <distributionManagement>
+    <site>
+      <id>apache.website</id>
+      <url>scm:svn:https://svn.apache.org/repos/asf/maven/website/components/${maven.site.path}/maven-shared-components</url>
+    </site>
+  </distributionManagement>
+
 </project>
diff --git a/...components/src/site-docs/apt/index.apt.vm → ...ared-components/src/site/apt/index.apt.vm b/...components/src/site-docs/apt/index.apt.vm → ...ared-components/src/site/apt/index.apt.vm
diff --git a/...-shared-components/src/site-docs/site.xml → ...maven-shared-components/src/site/site.xml b/...-shared-components/src/site-docs/site.xml → ...maven-shared-components/src/site/site.xml
@@ -32,20 +32,10 @@ under the License.
       <item name="Maven" href="../index.html"/>
       <item name="Plugins" href="../maven-plugins/index.html"/>
       <item name="Extensions" href="../maven-extensions/index.html"/>
-      <item name="Shared Components" href="../maven-shared-components/index.html"/>
+      <item name="Shared Components" href="index.html"/>
       <item name="Skins" href="../maven-skins/index.html"/>
       <item name="Doxia Tools" href="../doxia-tools/index.html"/>
     </menu>
 
-    <menu ref="reports" />
-
-    <menu name="ASF">
-      <item name="How Apache Works"  href="https://www.apache.org/foundation/how-it-works.html"/>
-      <item name="Foundation"        href="https://www.apache.org/foundation/"/>
-      <item name="Data Privacy"      href="https://privacy.apache.org/policies/privacy-policy-public.html"/>
-      <item name="Sponsoring Apache" href="https://www.apache.org/foundation/sponsorship.html"/>
-      <item name="Thanks"            href="https://www.apache.org/foundation/thanks.html"/>
-    </menu>
-
   </body>
 </project>
diff --git a/maven-skins/site-pom.xml → docs/maven-skins/pom.xml b/maven-skins/site-pom.xml → docs/maven-skins/pom.xml
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
@@ -18,29 +17,36 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
-
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
     <groupId>org.apache.maven</groupId>
-    <!-- we need to have a different gav for pom.xml and site-pom.xml -->
-    <!-- dot at the end is on purpose -->
-    <artifactId>maven-parent.</artifactId>
+    <artifactId>docs</artifactId>
     <version>42-SNAPSHOT</version>
-    <relativePath>../site-pom.xml</relativePath>
   </parent>
 
   <groupId>org.apache.maven.skins</groupId>
-  <artifactId>maven-skins</artifactId>
+  <artifactId>maven-skins-docs</artifactId>
   <packaging>pom</packaging>
 
   <name>Apache Maven Skins Parent POM</name>
   <description>This project consists of a POM that contains settings that are likely to be useful to any Maven Skin that is building and releasing code with Maven.</description>
+  <url>https://maven.apache.org/pom/maven/maven-skins</url>
+
+  <scm>
+    <url>https://github.com/apache/maven-parent/tree/${project.scm.tag}/maven-skins</url>
+  </scm>
 
   <issueManagement>
     <system>jira</system>
     <url>https://issues.apache.org/jira/projects/MPOM</url>
   </issueManagement>
+
+  <distributionManagement>
+    <site>
+      <id>apache.website</id>
+      <url>scm:svn:https://svn.apache.org/repos/asf/maven/website/components/${maven.site.path}/maven-skins</url>
+    </site>
+  </distributionManagement>
 </project>
diff --git a/maven-skins/src/site-docs/apt/index.apt.vm → docs/maven-skins/src/site/apt/index.apt.vm b/maven-skins/src/site-docs/apt/index.apt.vm → docs/maven-skins/src/site/apt/index.apt.vm
diff --git a/maven-skins/src/site-docs/site.xml → docs/maven-skins/src/site/site.xml b/maven-skins/src/site-docs/site.xml → docs/maven-skins/src/site/site.xml
@@ -33,18 +33,9 @@ under the License.
       <item name="Plugins" href="../maven-plugins/index.html"/>
       <item name="Extensions" href="../maven-extensions/index.html"/>
       <item name="Shared Components" href="../maven-shared-components/index.html"/>
-      <item name="Skins" href="../maven-skins/index.html"/>
+      <item name="Skins" href="index.html"/>
       <item name="Doxia Tools" href="../doxia-tools/index.html"/>
     </menu>
 
-    <menu ref="reports" />
-
-    <menu name="ASF">
-      <item name="How Apache Works"  href="https://www.apache.org/foundation/how-it-works.html"/>
-      <item name="Foundation"        href="https://www.apache.org/foundation/"/>
-      <item name="Data Privacy"      href="https://privacy.apache.org/policies/privacy-policy-public.html"/>
-      <item name="Sponsoring Apache" href="https://www.apache.org/foundation/sponsorship.html"/>
-      <item name="Thanks"            href="https://www.apache.org/foundation/thanks.html"/>
-    </menu>
   </body>
 </project>