You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sj...@apache.org on 2023/10/22 10:05:09 UTC
[maven-docck-plugin] 01/01: [MDOCCK-39] Prepare documentation for retired
This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch MDOCCK-39
in repository https://gitbox.apache.org/repos/asf/maven-docck-plugin.git
commit a465e1dea67fb18936a9ea59900fe54bc5bbbd62
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Sun Oct 22 12:04:26 2023 +0200
[MDOCCK-39] Prepare documentation for retired
---
pom.xml | 6 +-
src/site/apt/examples/file-output.apt.vm | 2 +
src/site/apt/index.apt.vm | 2 +
src/site/apt/usage.apt.vm | 2 +
src/site/xdoc/download.xml.vm | 95 ++++----------------------------
5 files changed, 20 insertions(+), 87 deletions(-)
diff --git a/pom.xml b/pom.xml
index 26852f1..e00a1d2 100644
--- a/pom.xml
+++ b/pom.xml
@@ -30,10 +30,10 @@ under the License.
</parent>
<artifactId>maven-docck-plugin</artifactId>
- <version>3.0.0-SNAPSHOT</version>
+ <version>1.2-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
- <name>Apache Maven Documentation Checker Plugin</name>
+ <name>(RETIRED) Apache Maven Documentation Checker Plugin</name>
<description>Checks for violations of the Plugin Documentation Standard.</description>
<prerequisites>
@@ -52,7 +52,7 @@ under the License.
</issueManagement>
<ciManagement>
<system>Jenkins</system>
- <url>https://ci-builds.apache.org/job/Maven/job/maven-box/job/maven-docck-plugin/</url>
+ <url>https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-docck-plugin/</url>
</ciManagement>
<distributionManagement>
<site>
diff --git a/src/site/apt/examples/file-output.apt.vm b/src/site/apt/examples/file-output.apt.vm
index ee916bb..956badb 100644
--- a/src/site/apt/examples/file-output.apt.vm
+++ b/src/site/apt/examples/file-output.apt.vm
@@ -27,6 +27,8 @@
Sending the output to a file
+<<<Note:>>> This plugin is retired. It is no longer maintained.
+
* Configuring your <<<pom.xml>>>
You can use the following configuration in your <<<pom.xml>>> to run the DOCCK
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index aee1342..8a2afc8 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -28,6 +28,8 @@
${project.name}
+<<<Note:>>> This plugin is retired. It is no longer maintained.
+
This plugin checks that a project complies with the
{{{http://maven.apache.org/guides/development/guide-plugin-documentation.html}Plugin Documentation Standard}}.
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index 97b3e77..69c85ee 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -27,6 +27,8 @@
Usage
+<<<Note:>>> This plugin is retired. It is no longer maintained.
+
This document is intended to provide instructions for using the
Maven DOCCK Plugin. In order for this discussion to be useful, it's
critical to cover two topics: Configuring your project's <<<pom.xml>>> to run
diff --git a/src/site/xdoc/download.xml.vm b/src/site/xdoc/download.xml.vm
index 3f71035..8b5503d 100644
--- a/src/site/xdoc/download.xml.vm
+++ b/src/site/xdoc/download.xml.vm
@@ -23,103 +23,30 @@ under the License.
<properties>
<title>Download ${project.name} Source</title>
</properties>
+
<body>
<section name="Download ${project.name} ${project.version} Source">
- <p>${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.</p>
-
- <p>You will be prompted for a mirror - if the file is not found on yours, please be patient, as it may take 24
- hours to reach all mirrors.<p/>
+ <p><strong>${project.name} ${project.version}</strong> is distributed in source format.</p>
- <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="https://www.apache.org/dist/maven/KEYS">KEYS</a> used by the Apache Maven
- developers.</p>
+ <p>Use a source archive if you intend to build <strong>${project.name}</strong> yourself.</p>
- <p>${project.name} is distributed under the <a href="http://www.apache.org/licenses/">Apache License, version 2.0</a>.</p>
+ <p>Otherwise, simply use the ready-made binary artifacts from <strong>central repository</strong>.</p>
- <p></p>We <b>strongly</b> encourage our users to configure a Maven repository mirror closer to their location, please read <a href="/guides/mini/guide-mirror-settings.html">How to Use Mirrors for Repositories</a>.</p>
+ <p><strong>${project.name}</strong> is distributed under the <a href="https://www.apache.org/licenses/">Apache License, version 2.0</a>.</p>
- <a name="mirror"/>
- <subsection name="Mirror">
+ <subsection name="Files">
- <p>
- [if-any logo]
- <a href="[link]">
- <img align="right" src="[logo]" border="0"
- alt="logo"/>
- </a>
- [end]
- The currently selected mirror is
- <b>[preferred]</b>.
- If you encounter a problem with this mirror,
- please select another mirror.
- If all mirrors are failing, there are
- <i>backup</i>
- mirrors
- (at the end of the mirrors list) that should be available.
- </p>
+ <p><strong>This plugin is retired. It is no longer maintained.</strong></p>
- <form action="[location]" method="get" id="SelectMirror">
- Other mirrors:
- <select name="Preferred">
- [if-any http]
- [for http]
- <option value="[http]">[http]</option>
- [end]
- [end]
- [if-any ftp]
- [for ftp]
- <option value="[ftp]">[ftp]</option>
- [end]
- [end]
- [if-any backup]
- [for backup]
- <option value="[backup]">[backup] (backup)</option>
- [end]
- [end]
- </select>
- <input type="submit" value="Change"/>
- </form>
+ <p>Historical releases can be found on our <a href="https://archive.apache.org/dist/maven/plugins/">archive site</a>.</p>
- <p>
- You may also consult the
- <a href="http://www.apache.org/mirrors/">complete list of
- mirrors.</a>
+ <p>It is essential that you <a href="https://www.apache.org/info/verification.html">verify the integrity</a> of the downloaded file
+ using the checksum (.sha512 file)
+ or using the signature (.asc file) against the public <a href="https://downloads.apache.org/maven/KEYS">KEYS</a> used by the Apache Maven developers.
</p>
</subsection>
-
- <subsection name="${project.name} ${project.version}">
-
- <p>This is the current stable version of ${project.name}.</p>
-
- <table>
- <thead>
- <tr>
- <th></th>
- <th>Link</th>
- <th>Checksum</th>
- <th>Signature</th>
- </tr>
- </thead>
- <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>
- </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>
-
- </subsection>
</section>
</body>
</document>