You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/06 13:18:27 UTC
(maven-project-info-reports-plugin) branch master updated (6a82963 -> 39a3ef3)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/maven-project-info-reports-plugin.git
from 6a82963 Verify the build against Maven 4 as well
new 2e2d2e3 Rename the site documents ahead of converting them
new 39a3ef3 Port the site documentation from APT to Markdown
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/site/apt/examples/individual-reports.apt | 36 ------
src/site/apt/examples/scm-report.apt.vm | 85 -------------
src/site/apt/examples/selective-reports.apt.vm | 62 ----------
src/site/apt/index.apt.vm | 132 ---------------------
src/site/apt/usage.apt | 37 ------
.../examples/custom-report.md.vm} | 87 ++++++--------
.../markdown/examples/individual-reports.md} | 20 +---
src/site/markdown/examples/scm-report.md.vm | 70 +++++++++++
.../markdown/examples/selective-reports.md.vm} | 43 ++++---
src/site/markdown/index.md | 71 +++++++++++
.../markdown/usage.md} | 20 +---
11 files changed, 217 insertions(+), 446 deletions(-)
delete mode 100644 src/site/apt/examples/individual-reports.apt
delete mode 100644 src/site/apt/examples/scm-report.apt.vm
delete mode 100644 src/site/apt/examples/selective-reports.apt.vm
delete mode 100644 src/site/apt/index.apt.vm
delete mode 100644 src/site/apt/usage.apt
rename src/site/{apt/examples/custom-report.apt.vm => markdown/examples/custom-report.md.vm} (52%)
copy src/{test/resources/org/apache/maven/report/projectinfo/AbstractProjectInfoTestCase.xml => site/markdown/examples/individual-reports.md} (63%)
create mode 100644 src/site/markdown/examples/scm-report.md.vm
copy src/{test/resources/plugin-configs/ci-management-plugin-config.xml => site/markdown/examples/selective-reports.md.vm} (51%)
create mode 100644 src/site/markdown/index.md
copy src/{test/resources/org/apache/maven/report/projectinfo/AbstractProjectInfoTestCase.xml => site/markdown/usage.md} (61%)
(maven-project-info-reports-plugin) 01/02: Rename the site documents ahead of converting them
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-project-info-reports-plugin.git
commit 2e2d2e3c36ab0210665164fc44b9f90cbfbeb499
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:53:00 2026 +0200
Rename the site documents ahead of converting them
A pure rename, so that git records it and `git log --follow` and `git blame` still
reach the history of each page after the conversion that follows. The content is
still APT at this point and the site does not build between the two commits.
---
.../custom-report.apt.vm => markdown/examples/custom-report.md.vm} | 0
.../individual-reports.apt => markdown/examples/individual-reports.md} | 0
.../examples/scm-report.apt.vm => markdown/examples/scm-report.md.vm} | 0
.../examples/selective-reports.md.vm} | 0
src/site/{apt/index.apt.vm => markdown/index.md} | 0
src/site/{apt/usage.apt => markdown/usage.md} | 0
6 files changed, 0 insertions(+), 0 deletions(-)
diff --git a/src/site/apt/examples/custom-report.apt.vm b/src/site/markdown/examples/custom-report.md.vm
similarity index 100%
rename from src/site/apt/examples/custom-report.apt.vm
rename to src/site/markdown/examples/custom-report.md.vm
diff --git a/src/site/apt/examples/individual-reports.apt b/src/site/markdown/examples/individual-reports.md
similarity index 100%
rename from src/site/apt/examples/individual-reports.apt
rename to src/site/markdown/examples/individual-reports.md
diff --git a/src/site/apt/examples/scm-report.apt.vm b/src/site/markdown/examples/scm-report.md.vm
similarity index 100%
rename from src/site/apt/examples/scm-report.apt.vm
rename to src/site/markdown/examples/scm-report.md.vm
diff --git a/src/site/apt/examples/selective-reports.apt.vm b/src/site/markdown/examples/selective-reports.md.vm
similarity index 100%
rename from src/site/apt/examples/selective-reports.apt.vm
rename to src/site/markdown/examples/selective-reports.md.vm
diff --git a/src/site/apt/index.apt.vm b/src/site/markdown/index.md
similarity index 100%
rename from src/site/apt/index.apt.vm
rename to src/site/markdown/index.md
diff --git a/src/site/apt/usage.apt b/src/site/markdown/usage.md
similarity index 100%
rename from src/site/apt/usage.apt
rename to src/site/markdown/usage.md
(maven-project-info-reports-plugin) 02/02: Port the site documentation from APT to Markdown
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-project-info-reports-plugin.git
commit 39a3ef35b1537a4cffb4175e70ea1c843bc098a5
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:53:00 2026 +0200
Port the site documentation from APT to Markdown
7 page(s) converted with doxia-converter and then cleaned up by hand:
- <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
becomes [text](url)
- the ASF license header becomes a single block HTML comment
- a page whose only Velocity reference was ${project.name} is now a plain
.md with the title spelled out
- a page that keeps a reference stays a .vm. Velocity reads ## as a line
comment and would silently swallow every ATX heading below level one, so
subsections use setext underlines and anything deeper is wrapped in
#[[ ... ]]#
- references APT rendered literally are escaped, so they do not resolve
Verified by building the site before and after and comparing every
generated page: the visible text and the link targets are unchanged apart
from <b>/<i> becoming <strong>/<em> and quotes in prose picking up the
Markdown module's typographic substitution.
---
src/site/markdown/examples/custom-report.md.vm | 87 ++++-----
src/site/markdown/examples/individual-reports.md | 50 ++---
src/site/markdown/examples/scm-report.md.vm | 67 +++----
src/site/markdown/examples/selective-reports.md.vm | 50 ++---
src/site/markdown/index.md | 203 +++++++--------------
src/site/markdown/usage.md | 51 ++----
6 files changed, 191 insertions(+), 317 deletions(-)
diff --git a/src/site/markdown/examples/custom-report.md.vm b/src/site/markdown/examples/custom-report.md.vm
index 0666c20..bc15faf 100644
--- a/src/site/markdown/examples/custom-report.md.vm
+++ b/src/site/markdown/examples/custom-report.md.vm
@@ -1,36 +1,27 @@
- ------
- Customize the Text Reports
- ------
- Vincent Siveton
- ------
- 2010-10-30
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ https://maven.apache.org/doxia/references/apt-format.html
-
-Customize the Text Reports
-
- Currently, all reports have a static renderer, only texts could be changed.
-
-+-----------------+
+<!--
+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.
+-->
+
+# Customize the Text Reports
+
+Currently, all reports have a static renderer, only texts could be changed.
+
+```xml
<project>
...
<reporting>
@@ -41,7 +32,7 @@ Customize the Text Reports
<version>${project.version}</version>
<configuration>
<!-- By default -->
- <customBundle>\${project.basedir}/src/site/custom/project-info-reports.properties</customBundle>
+ <customBundle>${esc.d}{project.basedir}/src/site/custom/project-info-reports.properties</customBundle>
</configuration>
</plugin>
...
@@ -49,21 +40,19 @@ Customize the Text Reports
</reporting>
...
</project>
-+-----------------+
+```
- To change texts in the reports, you should import the default Project Info report bundles from
- {{https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/}}
- and edit them. For example, if you want to modify the Mailing Lists introduction, you should edit the <<<report.mailing-lists.intro>>> property.
+To change texts in the reports, you should import the default Project Info report bundles from [https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/](https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/) and edit them. For example, if you want to modify the Mailing Lists introduction, you should edit the `report.mailing-lists.intro` property.
- Extract of the default bundle {{{https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-reports.properties}project-info-reports.properties}}:
+Extract of the default bundle [project-info-reports.properties](https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-reports.properties):
-+-----------------+
+```properties
report.mailing-lists.intro = These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.
-+-----------------+
+```
- Extract of a custom bundle <<<$\{project.basedir\}/src/site/custom/project-info-reports.properties>>> for the Apache Commons project:
+Extract of a custom bundle `${esc.d}{project.basedir}/src/site/custom/project-info-reports.properties` for the Apache Commons project:
-+-----------------+
+```unknown
report.mailing-lists.intro = These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.\
<p>\
@@ -91,13 +80,9 @@ report.mailing-lists.intro = These are the mailing lists that have been establis
in particular the section entitled\
<a href="http://www.apache.org/foundation/mailinglists.html#subscribe" class="externalLink">Subscribing and Unsubscribing</a>\
</p>
+```
-+-----------------+
-
- <<Notes:>>
-
- [[1]] You could also use Maven properties (i.e. <<<$\{project.artifactId\}>>>) in the messages.
-
- [[2]] If a bundle property is not defined in your custom bundle, the default will be displayed.
+**Notes:**
- []
+1. You could also use Maven properties (i.e. `${esc.d}{project.artifactId}`) in the messages.
+1. If a bundle property is not defined in your custom bundle, the default will be displayed.
diff --git a/src/site/markdown/examples/individual-reports.md b/src/site/markdown/examples/individual-reports.md
index c47eb0f..9632075 100644
--- a/src/site/markdown/examples/individual-reports.md
+++ b/src/site/markdown/examples/individual-reports.md
@@ -1,36 +1,24 @@
- ------
- Run Individual Reports
- ------
- Johnny R. Ruiz III, Pete Marvin King
- ------
- 2008-07-24
- ------
+<!--
+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
-~~ 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.
+http://www.apache.org/licenses/LICENSE-2.0
-~~ NOTE: For help with the syntax of this file, see:
-~~ https://maven.apache.org/doxia/references/apt-format.html
+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.
+-->
-Run Individual Reports
+# Run Individual Reports
- Each individual report can be generated without configuring anything in the
- <<<pom.xml>>>. Check the table in {{{../plugin-info.html}Goals}} for the
- complete list of goals.
+Each individual report can be generated without configuring anything in the `pom.xml`. Check the table in [Goals](../plugin-info.html) for the complete list of goals.
- <<Note:>> The reports generated using this method does not contain any
- navigational links. Also, the locale used is the JVM locale.
+**Note:** The reports generated using this method does not contain any navigational links. Also, the locale used is the JVM locale.
diff --git a/src/site/markdown/examples/scm-report.md.vm b/src/site/markdown/examples/scm-report.md.vm
index 60b17e6..54dabe0 100644
--- a/src/site/markdown/examples/scm-report.md.vm
+++ b/src/site/markdown/examples/scm-report.md.vm
@@ -1,43 +1,29 @@
- ------
- Customize the SCM Report
- ------
- The Maven Team
- ------
- 2010-09-07
- ------
+<!--
+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
-~~ 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.
+http://www.apache.org/licenses/LICENSE-2.0
-~~ NOTE: For help with the syntax of this file, see:
-~~ https://maven.apache.org/doxia/references/apt-format.html
+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.
+-->
-Customize the SCM Report
+# Customize the SCM Report
- By default, the SCM Report uses the information configured (or inherited)
- in the <<<\<scm\>>>> element of <<<pom.xml>>>. To override these values,
- you can configure the <<<webAccessUrl>>>, <<<anonymousConnection>>> and
- <<<developerConnection>>> properties.
+By default, the SCM Report uses the information configured (or inherited) in the `<scm>` element of `pom.xml`. To override these values, you can configure the `webAccessUrl`, `anonymousConnection` and `developerConnection` properties.
- This feature is useful when the project website is stored in
- a separate module, and you want the SCM report to give instructions for
- checking out the project trunk.
+This feature is useful when the project website is stored in a separate module, and you want the SCM report to give instructions for checking out the project trunk.
-+-----------------+
+```xml
<project>
...
<scm>
@@ -63,13 +49,13 @@ Customize the SCM Report
</reporting>
...
</project>
-+-----------------+
+```
-How to exclude SCM anonymous access info?
+# How to exclude SCM anonymous access info?
- Just do not specify the <<<\<connection/\>>>> tag in the <<<\<scm/\>>>> tag. For instance, you could have:
+Just do not specify the `<connection/>` tag in the `<scm/>` tag. For instance, you could have:
-+-----------------+
+```xml
<project>
...
<scm>
@@ -79,7 +65,6 @@ How to exclude SCM anonymous access info?
</scm>
...
</project>
-+-----------------+
+```
- <<Note>>: Due to {{{https://codehaus-plexus.github.io/}Plexus}} design, it is not possible to specify an empty value using
- the <<<\<anonymousConnection/\>>>> configuration element.
+**Note**: Due to [Plexus](https://codehaus-plexus.github.io/) design, it is not possible to specify an empty value using the `<anonymousConnection/>` configuration element.
diff --git a/src/site/markdown/examples/selective-reports.md.vm b/src/site/markdown/examples/selective-reports.md.vm
index c0fac76..4abc986 100644
--- a/src/site/markdown/examples/selective-reports.md.vm
+++ b/src/site/markdown/examples/selective-reports.md.vm
@@ -1,37 +1,27 @@
- ------
- Run Selective Reports
- ------
- Johnny R. Ruiz III, Pete Marvin King
- ------
- 2009-07-14
- ------
+<!--
+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
-~~ 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.
+http://www.apache.org/licenses/LICENSE-2.0
-~~ NOTE: For help with the syntax of this file, see:
-~~ https://maven.apache.org/doxia/references/apt-format.html
+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.
+-->
-Run Selective Reports
+# Run Selective Reports
- To run the reports selectively, you can configure it to include only the reports that you prefer.
- Use <<<mvn site>>> to generate the selected reports.
+To run the reports selectively, you can configure it to include only the reports that you prefer. Use `mvn site` to generate the selected reports.
-+-----------------+
+```xml
<project>
...
<reporting>
@@ -59,4 +49,4 @@ Run Selective Reports
</reporting>
...
</project>
-+-----------------+
+```
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 94ca6fd..d59e6ca 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,132 +1,71 @@
- ------
- Introduction
- ------
- Johnny R. Ruiz III
- <jr...@exist.com>
- ------
- 2013-07-22
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ https://maven.apache.org/doxia/references/apt-format.html
-
-${project.name}
-
- The Maven Project Info Reports plugin is used to generate reports information about the project.
-
-* Goals Overview
-
- The Project Info Reports Plugin has the following goals:
-
- * {{{./ci-management-mojo.html}project-info-reports:ci-management}} is used to generate the Project Continuous Integration
- Management report.
-
- * {{{./dependencies-mojo.html}project-info-reports:dependencies}} is used to generate the Project Dependencies
- report.
-
- * {{{./dependency-convergence-mojo.html}project-info-reports:dependency-convergence}} is used to generate the
- Project Dependency Convergence report for (reactor) builds.
-
- * {{{./dependency-info-mojo.html}project-info-reports:dependency-info}} is used to generate code snippets
- of the Maven coordinates to be added to build tools.
-
- * {{{./dependency-management-mojo.html}project-info-reports:dependency-management}} is used to generate the
- Project Dependency Management report.
-
- * {{{./distribution-management-mojo.html}project-info-reports:distribution-management}} is used to generate
- the Project Distribution Management report.
-
- * {{{./help-mojo.html}project-info-reports:help}} is used to display help information
- on the Project Info Reports Plugin.
-
- * {{{./index-mojo.html}project-info-reports:index}} is used to generate the Project index page.
-
- * {{{./issue-management-mojo.html}project-info-reports:issue-management}} is used to generate the Project Issue
- Management report.
-
- * {{{./licenses-mojo.html}project-info-reports:licenses}} is used to generate the Project Licenses report.
-
- * {{{./mailing-lists-mojo.html}project-info-reports:mailing-lists}} is used to generate the Project Mailing
- Lists report.
-
- * {{{./modules-mojo.html}project-info-reports:modules}} is used to generate the Project Modules report.
-
- * {{{./plugin-management-mojo.html}project-info-reports:plugin-management}} is used to generate the
- Project Plugin Management report.
-
- * {{{./plugins-mojo.html}project-info-reports:plugins}} is used to generate the Project Plugins report.
-
- * {{{./team-mojo.html}project-info-reports:team}} is used to generate the Project Team report.
-
- * {{{./scm-mojo.html}project-info-reports:scm}} is used to generate the Project Source Code Management report.
-
- * {{{./summary-mojo.html}project-info-reports:summary}} is used to generate the Project Summary report.
-
-* Upcoming Incompatibility Notice
-
- With a future version mojos and output filenames will change for consistency alignment.
- See the following table for the upcoming changes:
-
-*-----------------------*-------------------------*----------------------------*------------------------------*
-|| Goal Name || New Goal Name || Output name || New Output Name |
-*-----------------------+-------------------------+----------------------------+------------------------------+
-| <<<dependency-info>>> | <<<maven-coordinates>>> | <<<dependency-info.html>>> | <<<maven-coordinates.html>>> |
-*-----------------------+-------------------------+----------------------------+------------------------------+
-
-* Usage
-
- General instructions on how to use the Project Info Reports Plugin can be found on the {{{./usage.html}usage page}}. Some more
- specific use cases are described in the examples given below.
-
- In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
- free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
- already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
- the {{{./mailing-lists.html}mail archive}}.
-
- If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
- {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
- concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
- entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
- Of course, patches are welcome, too. Contributors can check out the project from our
- {{{./scm.html}source repository}} and will find supplementary information in the
- {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
-
-* Examples
-
- To provide you with better understanding on some usages of the Maven Project Info Reports Plugin,
- you can take a look into the following examples:
-
- * {{{./examples/selective-reports.html}Run Selective Reports}}
-
- * {{{./examples/individual-reports.html}Run Individual Reports}}
-
- * {{{./examples/scm-report.html}Customize the SCM Report}}
-
- * {{{./project-info.html}Overview of the reports generated for this plugin}}
-
- []
-
-* Related Links
-
- * {{{http://maven.apache.org/plugins/localization.html}Localization of Plugins}}
-
- * {{{http://maven.apache.org/plugins/maven-site-plugin/examples/creatingskins.html}Create a layout (skin))}}
-
- []
+<!--
+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.
+-->
+
+# Apache Maven Project Info Reports Plugin
+The Maven Project Info Reports plugin is used to generate reports information about the project.
+
+## Goals Overview
+
+The Project Info Reports Plugin has the following goals:
+
+- [project-info-reports:ci-management](./ci-management-mojo.html) is used to generate the Project Continuous Integration Management report.
+- [project-info-reports:dependencies](./dependencies-mojo.html) is used to generate the Project Dependencies report.
+- [project-info-reports:dependency-convergence](./dependency-convergence-mojo.html) is used to generate the Project Dependency Convergence report for (reactor) builds.
+- [project-info-reports:dependency-info](./dependency-info-mojo.html) is used to generate code snippets of the Maven coordinates to be added to build tools.
+- [project-info-reports:dependency-management](./dependency-management-mojo.html) is used to generate the Project Dependency Management report.
+- [project-info-reports:distribution-management](./distribution-management-mojo.html) is used to generate the Project Distribution Management report.
+- [project-info-reports:help](./help-mojo.html) is used to display help information on the Project Info Reports Plugin.
+- [project-info-reports:index](./index-mojo.html) is used to generate the Project index page.
+- [project-info-reports:issue-management](./issue-management-mojo.html) is used to generate the Project Issue Management report.
+- [project-info-reports:licenses](./licenses-mojo.html) is used to generate the Project Licenses report.
+- [project-info-reports:mailing-lists](./mailing-lists-mojo.html) is used to generate the Project Mailing Lists report.
+- [project-info-reports:modules](./modules-mojo.html) is used to generate the Project Modules report.
+- [project-info-reports:plugin-management](./plugin-management-mojo.html) is used to generate the Project Plugin Management report.
+- [project-info-reports:plugins](./plugins-mojo.html) is used to generate the Project Plugins report.
+- [project-info-reports:team](./team-mojo.html) is used to generate the Project Team report.
+- [project-info-reports:scm](./scm-mojo.html) is used to generate the Project Source Code Management report.
+- [project-info-reports:summary](./summary-mojo.html) is used to generate the Project Summary report.
+## Upcoming Incompatibility Notice
+
+With a future version mojos and output filenames will change for consistency alignment. See the following table for the upcoming changes:
+
+|Goal Name|New Goal Name|Output name|New Output Name|
+|:---:|:---:|:---:|:---:|
+|`dependency-info`|`maven-coordinates`|`dependency-info.html`|`maven-coordinates.html`|
+
+## Usage
+
+General instructions on how to use the Project Info Reports Plugin can be found on the [usage page](./usage.html). Some more specific use cases are described in the examples given below.
+
+In case you still have questions regarding the plugin's usage, please have a look at the [FAQ](./faq.html) and feel free to contact the [user mailing list](./mailing-lists.html). The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the [mail archive](./mailing-lists.html).
+
+If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our [issue tracker](./issue-management.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are wel [...]
+
+## Examples
+
+To provide you with better understanding on some usages of the Maven Project Info Reports Plugin, you can take a look into the following examples:
+
+- [Run Selective Reports](./examples/selective-reports.html)
+- [Run Individual Reports](./examples/individual-reports.html)
+- [Customize the SCM Report](./examples/scm-report.html)
+- [Overview of the reports generated for this plugin](./project-info.html)
+## Related Links
+
+- [Localization of Plugins](http://maven.apache.org/plugins/localization.html)
+- [Create a layout (skin))](http://maven.apache.org/plugins/maven-site-plugin/examples/creatingskins.html)
diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md
index 6bc4e07..94f18f5 100644
--- a/src/site/markdown/usage.md
+++ b/src/site/markdown/usage.md
@@ -1,37 +1,24 @@
- ------
- Usage
- ------
- Johnny R. Ruiz III, Pete Marvin King
- ------
- 2009-07-14
- ------
+<!--
+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
-~~ 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.
+http://www.apache.org/licenses/LICENSE-2.0
-~~ NOTE: For help with the syntax of this file, see:
-~~ https://maven.apache.org/doxia/references/apt-format.html
+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.
+-->
-Usage
+# Usage
- Maven has been configured to create the project info reports by default. There's
- no need to configure anything in your <<<pom.xml>>> to generate the project
- information reports.
+Maven has been configured to create the project info reports by default. There's no need to configure anything in your `pom.xml` to generate the project information reports.
- Simply running <<<mvn site>>> would generate the project information documentation.
- For more information on how to customize the Project Information Reports Plugin,
- check the examples on the {{{./index.html}Introduction}} page.
+Simply running `mvn site` would generate the project information documentation. For more information on how to customize the Project Information Reports Plugin, check the examples on the [Introduction](./index.html) page.