Download page template

apache · Dec 6, 2024 · db14e10 · db14e10
1 parent cf8e991
commit db14e10
Show file tree

Hide file tree

Showing 6 changed files with 146 additions and 76 deletions.
diff --git a/docs/pom.xml b/docs/pom.xml
@@ -70,8 +70,27 @@ under the License.
     <!-- modules with documentation not need to install and deploy -->
     <maven.install.skip>true</maven.install.skip>
     <maven.deploy.skip>true</maven.deploy.skip>
+
+    <downloadDirectory>pom</downloadDirectory>
+    <downloadArtifactId>maven-parent</downloadArtifactId>
   </properties>
 
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-remote-resources-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>site-download</id>
+            <phase>pre-site</phase>
+            <inherited>false</inherited>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
   <reporting>
     <plugins>
       <plugin>

diff --git a/docs/src/site/xdoc/download.xml.vm b/docs/src/site/xdoc/download.xml.vm
diff --git a/maven-shared-doc-resource/pom.xml b/maven-shared-doc-resource/pom.xml
@@ -0,0 +1,51 @@
+<?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
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+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>
+    <artifactId>maven-parent</artifactId>
+    <version>44-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>maven-shared-doc-resource</artifactId>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-remote-resources-plugin</artifactId>
+        <configuration>
+          <includes>
+            <include>**/*.vm</include>
+            <include>**/*.cgi</include>
+          </includes>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>bundle</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>
diff --git a/maven-shared-doc-resource/src/main/resources/markdown/download.md.vm b/maven-shared-doc-resource/src/main/resources/markdown/download.md.vm
@@ -0,0 +1,54 @@
+---
+title: Download ${project.name} Source
+---
+#*
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+*#
+#set( $h = "#" )
+#set( $downloadDirectory = $project.properties.downloadDirectory )
+#if( ! $downloadDirectory )
+#set( $downloadDirectory = "plugins" )
+#end
+#set( $downloadArtifactId = $project.properties.downloadArtifactId )
+#if( ! $downloadArtifactId )
+#set( $downloadArtifactId = $project.artifactId )
+#end
+
+# Download ${project.name} ${project.version} Source
+
+${project.name} ${project.version} is distributed in source format\. Use a source archive if you intend to build
+${project.name} yourself\. Otherwise, simply use the ready\-made binary artifacts from central repository\.
+
+In order to guard against corrupted downloads/installations, it is highly recommended to
+[verify the signature](https://www.apache.org/dev/release-signing#verifying-signature)
+of the release bundles against the public [KEYS](https://www.apache.org/dist/maven/KEYS) used by the Apache Maven
+developers\.
+
+${project.name} is distributed under the [Apache License, version 2\.0](https://www.apache.org/licenses/)\.
+
+${h}${h} ${project.name} ${project.version}
+
+This is the current stable version of ${project.name}\.
+
+|  | Link                                                                                                                                                   |Checksum|Signature|
+|---|--------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|
+${project.name} ${project.version} \(Source zip\)| [${downloadArtifactId}\-${project.version}\-source\-release\.zip](\[preferred\]/maven/${downloadDirectory}/${downloadArtifactId}-${project.version}-source-release.zip) |[${downloadArtifactId}\-${project.version}\-source\-release\.zip\.sha512](https://www.apache.org/dist/maven/${downloadDirectory}/${downloadArtifactId}-${project.version}-source-release.zip.sha512)|[${downloadArtifactId}\-${project.version}\-source\-release\.zip\.asc](https://www.apache.org/dist/maven/${downloadDirectory}/${downloadArtifactId}-${project.version}-source-release.zip.asc)|
+
+${h}${h} Previous Versions
+
+Older non\-recommended releases can be found on our [archive site](https://archive.apache.org/dist/maven/${downloadDirectory}/)\.
diff --git a/docs/src/site/resources/download.cgi → ...src/main/resources/resources/download.cgi b/docs/src/site/resources/download.cgi → ...src/main/resources/resources/download.cgi
diff --git a/pom.xml b/pom.xml
@@ -914,6 +914,7 @@ under the License.
     <module>maven-skins</module>
     <module>doxia-tools</module>
     <module>docs</module>
+    <module>maven-shared-doc-resource</module>
   </modules>
 
   <scm>
@@ -958,8 +959,9 @@ under the License.
     <!-- DO NOT UPGRADE to 4: incompatible with Maven 3 -->
     <version.plexus-xml>3.0.1</version.plexus-xml>
     <versions.junit5>5.11.3</versions.junit5>
-    <version.maven-fluido-skin>1.12.0</version.maven-fluido-skin>
+    <version.maven-fluido-skin>2.0.0</version.maven-fluido-skin>
     <version.maven-shared-resources>6</version.maven-shared-resources>
+    <version.maven-site-plugin>3.21.0</version.maven-site-plugin>
     <project.build.outputTimestamp>2024-07-04T20:44:45Z</project.build.outputTimestamp>
   </properties>
 
@@ -1230,6 +1232,25 @@ under the License.
             </execution>
           </executions>
         </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-remote-resources-plugin</artifactId>
+          <executions>
+            <execution>
+              <id>site-download</id>
+              <goals>
+                <goal>process</goal>
+              </goals>
+              <phase>none</phase>
+              <configuration>
+                <resourceBundles>
+                  <bundle>org.apache.maven:maven-shared-doc-resource:44-SNAPSHOT</bundle>
+                </resourceBundles>
+                <outputDirectory>${project.build.directory}/generated-site</outputDirectory>
+              </configuration>
+            </execution>
+          </executions>
+        </plugin>
       </plugins>
     </pluginManagement>