[MWRAPPER-14] update documentation

apache · Nov 8, 2021 · cb7df3a · cb7df3a
1 parent 5e71ecd
commit cb7df3a
Show file tree

Hide file tree

Showing 12 changed files with 92 additions and 47 deletions.
diff --git a/maven-wrapper-distribution/src/site/apt/index.apt.vm b/maven-wrapper-distribution/src/site/apt/index.apt.vm
@@ -55,4 +55,4 @@ mvnwDebug.cmd
 
  []
 
- Distribution can be installed in a project either by unpacking zip archive by hand, or by using {{{/plugins/maven-wrapper-plugin/}<<<wrapper:wrapper>>>}}.
+ Distribution can be installed in a project either by unpacking zip archive by hand, or by using {{{../maven-wrapper-plugin/}<<<wrapper:wrapper>>>}}.
diff --git a/maven-wrapper-distribution/src/site/site.xml b/maven-wrapper-distribution/src/site/site.xml
@@ -21,9 +21,6 @@ under the License.
 
 <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 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
-
-  <edit>${project.scm.url}</edit>
-
   <body>
     <menu ref="parent"/>
     <menu ref="reports"/>

diff --git a/maven-wrapper-plugin/src/site/markdown/index.md.vm b/maven-wrapper-plugin/src/site/markdown/index.md.vm
@@ -18,15 +18,14 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-The Apache Maven Wrapper Plugin helps with downloading and unpacking the [wrapper distribution](/ref/4-LATEST/apache-maven-wrapper/) 
-as introduced in Apache Maven 4.
+The Apache Maven Wrapper Plugin helps with downloading and unpacking the [wrapper distribution](../maven-wrapper-distribution/).
 
 Goals Overview
 --------------
 
 
  * [wrapper:wrapper](./wrapper-mojo.html) is the default goal invoked during the 
-   `wrapper` phase. It downloads and unpacks the apache-maven-wrapper distribution,
+   `wrapper` phase. It downloads and unpacks the maven-wrapper distribution,
 
 Usage
 -----

diff --git a/maven-wrapper-plugin/src/site/markdown/usage.md b/maven-wrapper-plugin/src/site/markdown/usage.md
@@ -48,12 +48,12 @@ This type comes with a `.mvn/wrapper/MavenWrapperDownloader.java` which will be
 Maven Version
 -------------
 By default the plugin will assume the same version as the Maven runtime (calling `mvn -v`). But you can pick a different version.
-Either call `mvn wrapper -DmavenVersion=x`, where x is any valid Apache Maven Release, see https://search.maven.org/artifact/org.apache.maven/apache-maven
+Either call `mvn wrapper:wrapper -DmavenVersion=x`, where x is any valid Apache Maven Release, see https://search.maven.org/artifact/org.apache.maven/apache-maven
 Another option is adjust the `distributionUrl` in `.mvn/wrapper/maven-wrapper.properties`
 
 Debugging
 ---------
 
 The apache-maven-wrapper distributions all contains the `mvnwDebug`-script for both Windows and Unix based operating systems. 
 This makes it possible to debug through Apache Maven, Maven Plugin or Maven Extension. 
-You can exclude these scripts by calling `mvn wrapper -DincludeDebug=false`
+You can exclude these scripts by calling `mvn wrapper:wrapper -DincludeDebug=false`
diff --git a/maven-wrapper-plugin/src/site/site.xml b/maven-wrapper-plugin/src/site/site.xml
@@ -27,14 +27,8 @@ under the License.
       <item name="Introduction" href="index.html"/>
       <item name="Goals" href="plugin-info.html"/>
       <item name="Usage" href="usage.html"/>
-      <!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
-      <item name="License" href="http://www.apache.org/licenses/"/>
-      <item name="Download" href="download.html"/>
-    </menu>
-
-    <menu name="Reference">
-      <item name="Wrapper Distribution" href="/ref/4-LATEST/apache-maven-wrapper/"/>
-      <item name="Wrapper" href="/ref/4-LATEST/maven-wrapper/"/>
     </menu>
+    <menu ref="parent"/>
+    <menu ref="reports"/>
   </body>
 </project>
diff --git a/maven-wrapper/src/site/apt/index.apt b/maven-wrapper/src/site/apt/index.apt
@@ -25,6 +25,6 @@
 
 Maven Wrapper
 
- Maven Wrapper dowloads Maven distribution if not already in cache, installs it, then launches Maven: Maven distributions installed by Maven Wrapper are stored under <<<~/.m2/wrapper/dists>>> by default.
+ Maven Wrapper downloads Maven distribution if not already in cache, installs it, then launches Maven: Maven distributions installed by Maven Wrapper are stored under <<<~/.m2/wrapper/dists>>> by default.
 
- Maven Wrapper is called by {{{../apache-maven-wrapper/}<<<mvnw>>>/<<<mvnw.cmd>>> scripts}} that need to be installed in the project source tree and called instead of <<<mvn>>>/<<<mvn.cmd>>>.
+ Maven Wrapper is called by {{{../maven-wrapper-distribution/}<<<mvnw>>>/<<<mvnw.cmd>>> scripts}} that need to be installed in the project source tree and called instead of <<<mvn>>>/<<<mvn.cmd>>>.
diff --git a/maven-wrapper/src/site/site.xml b/maven-wrapper/src/site/site.xml
@@ -22,8 +22,6 @@ under the License.
 <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 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
 
-  <edit>${project.scm.url}</edit>
-
   <body>
     <menu name="Overview">
       <item name="Introduction" href="index.html"/>

diff --git a/pom.xml b/pom.xml
@@ -40,10 +40,6 @@ under the License.
   </description>
   <inceptionYear>2020</inceptionYear>
 
-  <prerequisites>
-    <maven>${mavenVersion}</maven>
-  </prerequisites>
-
   <scm>
     <connection>scm:git:https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git</connection>
     <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git</developerConnection>
@@ -66,6 +62,7 @@ under the License.
   </distributionManagement>
 
   <properties>
+    <maven.site.path>wrapper-archives/wrapper-LATEST</maven.site.path>
     <mavenVersion>3.1.0</mavenVersion>
     <javaVersion>8</javaVersion>
     <project.build.outputTimestamp>2021-04-05T14:15:37Z</project.build.outputTimestamp>
@@ -76,21 +73,4 @@ under the License.
     <module>maven-wrapper-distribution</module>
     <module>maven-wrapper-plugin</module>
   </modules>
-
-  <build>
-    <pluginManagement>
-      <plugins>
-        <plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-jxr-plugin</artifactId>
-          <version>3.0.0</version>
-        </plugin>
-        <plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-project-info-reports-plugin</artifactId>
-          <version>3.1.0</version>
-        </plugin>
-      </plugins>
-    </pluginManagement>
-  </build>
 </project>
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
@@ -0,0 +1,35 @@
+~~ 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.
+
+ -----
+ Introduction
+ -----
+ Hervé Boutemy
+ -----
+ 2021-04-05
+ -----
+
+Maven Wrapper
+
+ Maven Wrapper is composed of 3 pieces:
+
+ - {{{./maven-wrapper/} maven-wrapper}},
+
+ - {{{./maven-wrapper-distribution/} maven-wrapper distribution}}, that provides <<<mvnw>>>:<<<mvnw.cmd>>> scripts distributions,
+
+ - {{{./maven-wrapper-plugin/} maven-wrapper-plugin}}, a plugin to ease installing Wrapper into a project.
+
diff --git a/...er-plugin/src/site/resources/download.cgi → src/site/resources/download.cgi b/...er-plugin/src/site/resources/download.cgi → src/site/resources/download.cgi
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -0,0 +1,42 @@
+<?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="https://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="https://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+  <body>
+    <breadcrumbs>
+      <item name="Wrapper" href="https://maven.apache.org/wrapper/index.html" />
+    </breadcrumbs>
+
+    <menu name="Overview">
+      <item name="Introduction" href="index.html"/>
+      <!--item name="JavaDocs" href="apidocs/index.html"/-->
+      <!--item name="Source Xref" href="xref/index.html"/-->
+      <!--item name="FAQ" href="faq.html"/-->
+      <!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
+      <item name="License" href="https://www.apache.org/licenses/"/>
+      <item name="Download" href="download.html"/>
+    </menu>
+
+    <menu ref="modules" />
+  </body>
+</project>
diff --git a/...pper-plugin/src/site/xdoc/download.xml.vm → src/site/xdoc/download.xml.vm b/...pper-plugin/src/site/xdoc/download.xml.vm → src/site/xdoc/download.xml.vm
@@ -34,7 +34,7 @@ under the License.
 
       <p>In order to guard against corrupted downloads/installations, it is highly recommended to
       <a href="http://www.apache.org/dev/release-signing#verifying-signature">verify the signature</a>
-      of the release bundles against the public <a href="http://www.apache.org/dist/maven/KEYS">KEYS</a> used by the Apache Maven
+      of the release bundles against the public <a href="https://www.apache.org/dist/maven/KEYS">KEYS</a> used by the Apache Maven
       developers.</p>
 
       <p>${project.name} is distributed under the <a href="http://www.apache.org/licenses/">Apache License, version 2.0</a>.</p>
@@ -107,17 +107,17 @@ under the License.
         <tbody>
           <tr>
             <td>${project.name} ${project.version} (Source zip)</td>
-            <td><a href="[preferred]maven/plugins/${project.artifactId}-${project.version}-source-release.zip">maven/plugins/${project.artifactId}-${project.version}-source-release.zip</a></td>
-            <td><a href="https://www.apache.org/dist/maven/plugins/${project.artifactId}-${project.version}-source-release.zip.sha512">maven/plugins/${project.artifactId}-${project.version}-source-release.zip.sha512</a></td>
-            <td><a href="https://www.apache.org/dist/maven/plugins/${project.artifactId}-${project.version}-source-release.zip.asc">maven/plugins/${project.artifactId}-${project.version}-source-release.zip.asc</a></td>
+            <td><a href="[preferred]maven/wrapper/${project.artifactId}-${project.version}-source-release.zip">maven/wrapper/${project.artifactId}-${project.version}-source-release.zip</a></td>
+            <td><a href="https://www.apache.org/dist/maven/wrapper/${project.artifactId}-${project.version}-source-release.zip.sha512">maven/wrapper/${project.artifactId}-${project.version}-source-release.zip.sha512</a></td>
+            <td><a href="https://www.apache.org/dist/maven/wrapper/${project.artifactId}-${project.version}-source-release.zip.asc">maven/wrapper/${project.artifactId}-${project.version}-source-release.zip.asc</a></td>
           </tr>
         </tbody>
       </table>
       </subsection>
 
       <subsection name="Previous Versions">
 
-      <p>Older non-recommended releases can be found on our <a href="http://archive.apache.org/dist/maven/plugins/">archive site</a>.</p>
+      <p>Older non-recommended releases can be found on our <a href="http://archive.apache.org/dist/maven/wrapper/">archive site</a>.</p>
 
       </subsection>
     </section>