You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sl...@apache.org on 2023/02/09 00:34:07 UTC
svn commit: r1907531 [6/25] - in /maven/website/content: ./ apache-resource-bundles/ archives/maven-2.x/ background/ developers/ developers/conventions/ developers/release/ developers/website/ docs/ docs/2.0.1/ docs/2.0.10/ docs/2.0.11/ docs/2.0.2/ doc...
Modified: maven/website/content/guides/development/guide-building-maven.html
==============================================================================
--- maven/website/content/guides/development/guide-building-maven.html (original)
+++ maven/website/content/guides/development/guide-building-maven.html Thu Feb 9 00:34:05 2023
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-building-maven.apt at 2023-02-08
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-building-maven.md at 2023-02-09
| Rendered using Apache Maven Fluido Skin 1.11.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
@@ -10,8 +10,7 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" />
- <meta name="author" content="Brett Porter
-Jason van Zyl" />
+ <meta name="author" content="Brett Porter, Jason van Zyl" />
<meta name="date" content="2015-01-04" />
<title>Maven – Guide to Building Maven</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" />
@@ -49,8 +48,8 @@ Jason van Zyl" />
<ul class="breadcrumb">
<li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Guide to Building Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-building-maven.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-08</li>
+ <li class="active ">Guide to Building Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-building-maven.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-09</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
<li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li>
@@ -140,38 +139,65 @@ Jason van Zyl" />
</div>
</header>
<main id="bodyColumn" class="span10" >
-<section>
-<h1>Building Maven</h1><section>
-<h2>Why would I want to build Maven?</h2>
+<!--
+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.
+-->
+<section><section>
+<h2>Building Maven</h2><section>
+<h3>Why would I want to build Maven?</h3>
<p>Building Maven (or a plugin, or any component) yourself is for one of two reasons:</p>
<ul>
-<li>to try out a bleeding edge feature or bugfix (issues can be found in <a href="/issue-management.html"> JIRA</a>),</li>
-<li>to fix a problem you are having and submit a patch to the developers team.</li></ul></section><section>
-<h2>Checking out the sources</h2>
+
+<li>
+<p>to try out a bleeding edge feature or bugfix (issues can be found in <a href="/issue-management.html">JIRA</a>),</p></li>
+<li>
+<p>to fix a problem you are having and submit a patch to the developers team.</p></li>
+</ul></section><section>
+<h3>Checking out the sources</h3>
<p>All of the source code for Maven and its related libraries is in managed in the ASF source code repositories: for details, see <a href="/scm.html">https://maven.apache.org/scm.html</a>.</p></section><section>
-<h2>Building Maven</h2><section>
-<h3>Building a Maven Plugin or Component</h3>
+<h3>Building Maven</h3><section>
+<h4>Building a Maven Plugin or Component</h4>
<p>Building a Maven plugin or component is like any Maven build:</p>
-<div>
-<pre>mvn install</pre></div><section>
-<h4>Running Integration Tests</h4>
+
+<div class="source"><pre class="prettyprint linenums"><code>mvn install
+</code></pre></div><section>
+<h5>Running Integration Tests</h5>
<p>Before submitting a patch, it is advised to run the integration tests, which are available in the <code>run-its</code> profile:</p>
-<div>
-<pre>mvn -Prun-its install</pre></div></section></section><section>
-<h3>Building Maven core</h3>
+
+<div class="source"><pre class="prettyprint linenums"><code>mvn -Prun-its install
+</code></pre></div></section></section><section>
+<h4>Building Maven core</h4>
<p>Until Maven 3.3, Maven core build could be boostrapped with an Ant build. This bootstrap has been removed in Maven 3.5: you need a pre-built Maven to build Maven from source.</p>
<p>To do this, run from the source directory:</p>
-<div>
-<pre>mvn install</pre></div>
+
+<div class="source"><pre class="prettyprint linenums"><code>mvn install
+</code></pre></div>
<p>The assemblies will be created in <code>apache-maven</code>, and can be manually unzipped to the location where you'd like the resulting Maven installed.</p>
<p>If you want to have the resulting Maven directly copied to a directory, you can use the <code>distributionTargetDir</code> property:</p>
-<div>
-<pre>mvn -DdistributionTargetDir="$HOME/app/maven/apache-maven-SNAPSHOT" install</pre></div><section>
-<h4>Running the full Maven core integration tests</h4>
+
+<div class="source"><pre class="prettyprint linenums"><code>mvn -DdistributionTargetDir="$HOME/app/maven/apache-maven-SNAPSHOT" install
+</code></pre></div><section>
+<h5>Running the full Maven core integration tests</h5>
<p>Before checking in a change or submitting a patch to Maven core, it is required to run the core integration tests. Using your local build of Maven, run:</p>
-<div>
-<pre>mvn test -Prun-its</pre></div>
-<p>Consult <a href="/core-its/">Core ITs documentation</a> for more options.</p></section></section></section></section>
+
+<div class="source"><pre class="prettyprint linenums"><code>mvn test -Prun-its
+</code></pre></div>
+<p>Consult <a href="/core-its/">Core ITs documentation</a> for more options.</p></section></section></section></section></section>
</main>
</div>
</div>
Modified: maven/website/content/guides/development/guide-committer-school.html
==============================================================================
--- maven/website/content/guides/development/guide-committer-school.html (original)
+++ maven/website/content/guides/development/guide-committer-school.html Thu Feb 9 00:34:05 2023
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-committer-school.apt at 2023-02-08
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-committer-school.md at 2023-02-09
| Rendered using Apache Maven Fluido Skin 1.11.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
@@ -10,10 +10,8 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" />
- <meta name="author" content="Stephen Connolly
-Robert Scholte" />
- <meta name="date" content="2012-07-11
-2017-07-21" />
+ <meta name="author" content="Stephen Connolly, Robert Scholte" />
+ <meta name="date" content="2012-07-11, 2017-07-21" />
<title>Maven – Do you want to become a Maven Committer?</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" />
<link rel="stylesheet" href="../../css/site.css" />
@@ -50,8 +48,8 @@ Robert Scholte" />
<ul class="breadcrumb">
<li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Do you want to become a Maven Committer? <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-committer-school.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-08</li>
+ <li class="active ">Do you want to become a Maven Committer? <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-committer-school.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-09</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
<li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li>
@@ -141,71 +139,92 @@ Robert Scholte" />
</div>
</header>
<main id="bodyColumn" class="span10" >
-<section>
-<h1>Do you want to become a Maven Committer?</h1>
+<!--
+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.
+-->
+<!-- Original post: http://javaadventure.blogspot.nl/2012/07/do-you-want-to-become-maven-committer.html -->
+<section><section>
+<h2>Do you want to become a Maven Committer?</h2>
<p>The Apache Software Foundation is a meritocracy. By this we mean that you gain status based on the merit of your work and actions. In fact the status that you gain is a recognition of the merit of your work and actions.</p>
<p>Maven is an Apache project, that means that we have to follow the Apache rules and way. One of those rules is that we cannot hand out commit access to anyone who asks for it.</p>
<p>To gain commit access you must establish your merit by submitting patches that get picked up by existing committers.</p>
<p>After you have contributed enough patches to establish merit, the project management committee decides whether you can be trusted with commit access.</p>
-<p><i>The reality is that "It is what it is"TL;DR To become a Maven committer write good patches and get them applied.</i></p></section><section>
-<h1>What makes a good patch?</h1>
+<p><em>The reality is that "It is what it is"TL;DR To become a Maven committer write good patches and get them applied.</em></p></section><section>
+<h2>What makes a good patch?</h2>
<p>A good patch is a patch that applies cleanly and includes tests that cover both the positive and negative case and has documentation where relevant.</p>
-<p>For example, if you were implementing a patch to fix <a class="externalLink" href="http://issues.apache.org/jira/browse/MNG-4612">MNG-4612</a> you would first need to write a test case that is failing when trying to encrypt</p>
-<div>
-<pre>{DESede}y+qq...==</pre></div>
+<p>For example, if you were implementing a patch to fix <a href="http://issues.apache.org/jira/browse/MNG-4612" class="externalLink">MNG-4612</a> you would first need to write a test case that is failing when trying to encrypt</p>
+
+<div class="source"><pre class="prettyprint linenums"><code>{DESede}y+qq...==
+</code></pre></div>
<p>and a second test case that is passing when trying to encrypt</p>
-<div>
-<pre>password</pre></div>
+
+<div class="source"><pre class="prettyprint linenums"><code>password
+</code></pre></div>
<p>This is in order to be sure that you have written an effective test case that can pass for good data. Then you implement the fix and all the tests should pass. You then take a Subversion compatible† diff of the source code and attach that to the issue in question.</p>
<p>To understand how your patch gets evaluated, here is how I apply patches:</p>
-<ol style="list-style-type: decimal">
-<li>I look at the actual diff, if there is a whole lot of formatting changes irrelevant to the issue being fixed => <b>Patch is no good, ask on JIRA for a clean patch</b></li>
-<li>I look at the list of files in the diff, if there are no tests => <b>Patch is no good, ask on JIRA for test cases</b></li>
-<li>I look at the issue and if the issue requires documentation be updated and there is no documentation changes in the patch => <b>Patch is no good, ask on JIRA for documentation changes in the patch</b></li>
-<li>I take a clean checkout of the source that the patch applies to and try to apply the patch... if it does not apply clean => <b>Patch is no good, ask on JIRA for an updated patch</b></li>
-<li>I revert the src/main and run the tests. If the tests all pass, then there are no test cases to catch the bug => <b>Patch is no good, ask on JIRA for proper tests</b></li>
-<li>I revert src and run the tests. If any tests fail, then there is something wrong with the existing code => <b>If I have time I might try and fix the issue, otherwise I just move on</b></li>
-<li>I apply the patch a second time and run the tests. If the tests all pass => <b>Patch is good, I commit the patch and mark the JIRA as resolved</b></li></ol>
-<p>So there you have it, my guide to writing good patches... now the next step is getting your patches noticed...</p></section><section>
-<h1>How to get your patches noticed</h1>
+<p>1 I look at the actual diff, if there is a whole lot of formatting changes irrelevant to the issue being fixed => <strong>Patch is no good, ask on JIRA for a clean patch</strong></p>
+<p>1 I look at the list of files in the diff, if there are no tests => <strong>Patch is no good, ask on JIRA for test cases</strong></p>
+<p>1 I look at the issue and if the issue requires documentation be updated and there is no documentation changes in the patch => <strong>Patch is no good, ask on JIRA for documentation changes in the patch</strong></p>
+<p>1 I take a clean checkout of the source that the patch applies to and try to apply the patch… if it does not apply clean => <strong>Patch is no good, ask on JIRA for an updated patch</strong></p>
+<p>1 I revert the src/main and run the tests. If the tests all pass, then there are no test cases to catch the bug => <strong>Patch is no good, ask on JIRA for proper tests</strong></p>
+<p>1 I revert src and run the tests. If any tests fail, then there is something wrong with the existing code => <strong>If I have time I might try and fix the issue, otherwise I just move on</strong></p>
+<p>1 I apply the patch a second time and run the tests. If the tests all pass => <strong>Patch is good, I commit the patch and mark the JIRA as resolved</strong></p>
+<p>So there you have it, my guide to writing good patches… now the next step is getting your patches noticed…</p></section><section>
+<h2>How to get your patches noticed</h2>
<p>The simplest way to get your patches noticed is to submit them to the JIRA issue that they fix.</p>
-<p>Remember that the Maven project is run by volunteers in their spare time, so very often we may not notice your patch for a few days. </p>
-<p>If you are certain that your patch is a good patch, and a week has passed with no comments on JIRA, then you should send <i>one and only one</i> email to the <a class="externalLink" href="mailto:dev@maven.apache.org">dev@maven.apache.org</a> mailing list to see if your patch can get noticed.</p>
-<p><b>Note:</b> you need to be fairly confident that your patch is a good patch, because if you keep on pestering the Maven developers looking to have non-good patches applied, your merit will become negative and people will be less inclined to help you get your patches applied... also this is why you should send one and <i>only one</i> email about your patch on any specific JIRA issue.</p></section><section>
-<h1>Stephen, Arnaud & Barrie's school for potential Maven committers</h1>
-<p>To help people who are interested in becoming Maven committers fulfill their goals, myself, Arnaud Heritier and Barrie Treloar (along with any other current Maven committers who decide to help) will be running an assignment based class to help people become committers. </p>
+<p>Remember that the Maven project is run by volunteers in their spare time, so very often we may not notice your patch for a few days.</p>
+<p>If you are certain that your patch is a good patch, and a week has passed with no comments on JIRA, then you should send <em>one and only one</em> email to the <a href="mailto:dev@maven.apache.org" class="externalLink">dev@maven.apache.org</a> mailing list to see if your patch can get noticed.</p>
+<p><strong>Note:</strong> you need to be fairly confident that your patch is a good patch, because if you keep on pestering the Maven developers looking to have non-good patches applied, your merit will become negative and people will be less inclined to help you get your patches applied… also this is why you should send one and <em>only one</em> email about your patch on any specific JIRA issue.</p></section><section>
+<h2>Stephen, Arnaud & Barrie's school for potential Maven committers</h2>
+<p>To help people who are interested in becoming Maven committers fulfill their goals, myself, Arnaud Heritier and Barrie Treloar (along with any other current Maven committers who decide to help) will be running an assignment based class to help people become committers.</p>
<p>To register for the class you need to complete the following steps:</p>
-<ol style="list-style-type: decimal">
-<li>Read the <a class="externalLink" href="http://www.apache.org/licenses/icla.txt">Apache Individual Contributor License Agreement</a>. When you graduate from the class you will be required to sign this in order to become a committer.</li>
-<li>Subscribe to the <a class="externalLink" href="mailto:dev@maven.apache.org">dev@maven.apache.org</a> mailing list.</li>
-<li>Send an email to the list with the Subject line: <code>[Committer School] I would like to become a committer</code> and the Message body:
-<div>
-<pre>I am interested in the following areas:
+<p>1 Read the <a href="http://www.apache.org/licenses/icla.txt" class="externalLink">Apache Individual Contributor License Agreement</a>. When you graduate from the class you will be required to sign this in order to become a committer.</p>
+<p>1 Subscribe to the <a href="mailto:dev@maven.apache.org" class="externalLink">dev@maven.apache.org</a> mailing list.</p>
+<p>1 Send an email to the list with the Subject line: <code>\[Committer School\] I would like to become a committer</code> and the Message body:</p>
+
+<div class="source"><pre class="prettyprint linenums"><code>I am interested in the following areas:
_______, _______ and ______
If anyone knows any issues that I could take a look at I would be very much appreciated
-Thanks</pre></div></li></ol>
+Thanks
+</code></pre></div>
<p>Once you have registered your class assignments are basically to find JIRA issues that you want to fix. The issues can be in any part of Maven, but it is best to start with the areas you have the most interest in. Once you have found a JIRA issue that you are interested in fixing, the process will work a little something like this:</p>
-<ol style="list-style-type: decimal">
-<li>Make sure that nobody else is working on the issue and that the issue is one that should be fixed by sending an email to the list with a Subject line something like: <code>[Committer School] Should I fix MNG-4612?</code> The Message body should be something like:
-<div>
-<pre>I have had a look at MNG-4612 and I think this is a real issue because...
+<p>1 Make sure that nobody else is working on the issue and that the issue is one that should be fixed by sending an email to the list with a Subject line something like: <code>\[Committer School\] Should I fix MNG-4612?</code> The Message body should be something like:</p>
+
+<div class="source"><pre class="prettyprint linenums"><code>I have had a look at MNG-4612 and I think this is a real issue because...
I think I can fix it like so....
Is that the correct way to go about fixing it and is it a real issue at all
-Thanks</pre></div></li>
-<li>Wait a couple of days. Arnaud, Barrie and I will do our best to respond quickly to all such emails, but please keep in mind that we are doing this in our spare time.</li>
-<li>If you get the all clear, develop your patch and upload it to the JIRA, after it is uploaded, send an email to the list with a subject line something like: <code>[Committer School] Patch for review: MNG-4612</code> The Message body should be something like:
-<div>
-<pre>I have tested that this is a good patch and I would appreciate if a committer could review and apply
-
-Thanks</pre></div></li></ol>
-<p>Keep in mind that the Committer School is just a way for us to identify people who are committed to developing patches with a view to eventually becoming committers. </p>
+Thanks
+</code></pre></div>
+<p>1 Wait a couple of days. Arnaud, Barrie and I will do our best to respond quickly to all such emails, but please keep in mind that we are doing this in our spare time.</p>
+<p>1 If you get the all clear, develop your patch and upload it to the JIRA, after it is uploaded, send an email to the list with a subject line something like: <code>\[Committer School\] Patch for review: MNG-4612</code> The Message body should be something like:</p>
+
+<div class="source"><pre class="prettyprint linenums"><code>I have tested that this is a good patch and I would appreciate if a committer could review and apply
+
+Thanks
+</code></pre></div>
+<p>Keep in mind that the Committer School is just a way for us to identify people who are committed to developing patches with a view to eventually becoming committers.</p>
<p>When we have enough evidence that we think we can get you accepted as a committer we will nominate you and hopefully your nomination will be accepted.</p>
-<p>Personally, if I see somebody averaging a good patch a week for 2-3 months and being active helping out on the <a class="externalLink" href="mailto:users@maven.apache.org">users@maven.apache.org</a> and <a class="externalLink" href="mailto:dev@maven.apache.org">dev@maven.apache.org</a> mailing lists then I think I could make a strong case for such a person being given commit access.</p>
-<p>So if you think you have the right stuff and want to become a Maven committer... class enrollment is open!</p></section>
+<p>Personally, if I see somebody averaging a good patch a week for 2-3 months and being active helping out on the <a href="mailto:users@maven.apache.org" class="externalLink">users@maven.apache.org</a> and <a href="mailto:dev@maven.apache.org" class="externalLink">dev@maven.apache.org</a> mailing lists then I think I could make a strong case for such a person being given commit access.</p>
+<p>So if you think you have the right stuff and want to become a Maven committer… class enrollment is open!</p></section></section>
</main>
</div>
</div>
Modified: maven/website/content/guides/development/guide-documentation-style.html
==============================================================================
--- maven/website/content/guides/development/guide-documentation-style.html (original)
+++ maven/website/content/guides/development/guide-documentation-style.html Thu Feb 9 00:34:05 2023
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-documentation-style.apt at 2023-02-08
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-documentation-style.md at 2023-02-09
| Rendered using Apache Maven Fluido Skin 1.11.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
@@ -48,8 +48,8 @@
<ul class="breadcrumb">
<li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Guide To Maven Documentation Style <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-documentation-style.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-08</li>
+ <li class="active ">Guide To Maven Documentation Style <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-documentation-style.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-09</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
<li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li>
@@ -123,37 +123,63 @@
</div>
</header>
<main id="bodyColumn" class="span10" >
-<section>
-<h1>Guide To Maven Documentation Style</h1><section>
-<h2>Where did the style came from?</h2>
+<!--
+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.
+-->
+<section><section>
+<h2>Guide To Maven Documentation Style</h2><section>
+<h3>Where did the style came from?</h3>
<p>The documentation style guide was created to make our documentation more consistent and also to apply best practices to the documentation as well. The standard has just been started and will expand over time based on the suggestions made on the Maven dev mailing list. It is a community consensus of how we should write our documentation.</p>
<p>Each rule in this guide should come with a motivation as to why it exists. References to external sources are encouraged.</p></section><section>
-<h2>Date format</h2>
+<h3>Date format</h3>
<p>How people format a date varies around the world, sometimes making it hard for people to understand each other. The solution to this problem comes in the form of the ISO-8601 standard.</p>
<p>A date in our documentation must follow this standard:</p>
-<p><b>YYYY-MM-DD</b></p>
-<p>where <b>YYYY</b> is the year in the Gregorian calendar, <b>MM</b> is the month of the year between 01 (January) and 12 (December), and <b>DD</b> is the day of the month between 01 and 31.</p>
-<p><b>Note</b>: All documentation meta-data should respect this convention, for instance for this given APT document:</p>
-<div>
-<pre> ------
+<p><strong>YYYY-MM-DD</strong></p>
+<p>where <strong>YYYY</strong> is the year in the Gregorian calendar, <strong>MM</strong> is the month of the year between 01 (January) and 12 (December), and <strong>DD</strong> is the day of the month between 01 and 31.</p>
+<p><strong>Note</strong>: All documentation meta-data should respect this convention, for instance for this given APT document:</p>
+
+<div class="source"><pre class="prettyprint linenums"><code> ------
Guide To Maven Documentation Style
------
Dennis Lundberg
------
2008-07-03
- ------</pre></div><section>
-<h3>References</h3>
+ ------
+</code></pre></div><section>
+<h4>References</h4>
<ul>
-<li><a class="externalLink" href="http://www.w3.org/QA/Tips/iso-date">W3C Quality Web Tips</a></li>
-<li><a class="externalLink" href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26780">ISO-8601</a></li>
-<li><a class="externalLink" href="http://en.wikipedia.org/wiki/ISO_8601">Wikipedia</a></li></ul></section></section><section>
-<h2>POM Snippet</h2>
+
+<li>
+<p><a href="http://www.w3.org/QA/Tips/iso-date" class="externalLink">W3C Quality Web Tips</a></p></li>
+<li>
+<p><a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26780" class="externalLink">ISO-8601</a></p></li>
+<li>
+<p><a href="http://en.wikipedia.org/wiki/ISO_8601" class="externalLink">Wikipedia</a></p></li>
+</ul><!-- NOTE: Add more rules here. Follow the heading style of the rule above. -->
+</section></section><section>
+<h3>POM Snippet</h3>
<p>A POM file must use 2 spaces for each indentation. Because POM snippets are often used in documentation to show the user how to configure something, it is important that these snippets aren't too wide. If they are too wide, the page is difficult to read on a smaller screen.</p>
<p>When you use a snippet of XML from the POM as an example in documentation, make sure that the example is properly indented. A user should be able to copy and paste the example into their own POM without changing the indentation.</p>
-<p>Also, you should declare all parent POM elements to improve the comprehension. You could use ellipsis (i.e. ...) if you don't want to specify elements.</p><section>
-<h3>Example</h3>
+<p>Also, you should declare all parent POM elements to improve the comprehension. You could use ellipsis (i.e. …) if you don't want to specify elements.</p><section>
+<h4>Example</h4>
<p>The following is an example of how the distribution management of the Maven site is configured.</p>
-<div class="source"><pre class="prettyprint linenums"><project>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
...
<distributionManagement>
<site>
@@ -162,18 +188,22 @@
</site>
</distributionManagement>
...
-</project></pre></div>
-<p>As you can see above the <code><distributionManagement></code> element is indented once (=2 spaces), the <code><site></code> element is indented twice (=4 spaces), and the <code><id></code> is indented three times (=6 spaces).</p></section></section><section>
-<h2>Naming Documentation Files</h2>
+</project>
+</code></pre></div>
+<p>As you can see above the <code>\<distributionManagement\></code> element is indented once (=2 spaces), the <code>\<site\></code> element is indented twice (=4 spaces), and the <code>\<id\></code> is indented three times (=6 spaces).</p></section></section><section>
+<h3>Naming Documentation Files</h3>
<p>All file names should replace space by a hyphen (-), for instance for this given APT document:</p>
-<div>
-<pre> guide-documentation-style.apt</pre></div></section><section>
-<h2>Updating Documentation Files</h2>
+
+<div class="source"><pre class="prettyprint linenums"><code> guide-documentation-style.apt
+</code></pre></div></section><section>
+<h3>Updating Documentation Files</h3>
<p>A good practice is to update the date (with the correct date format) when you are updating documentation files.</p></section><section>
-<h2>Write Thinking</h2>
+<h3>Write Thinking</h3>
<p>Here are some pointers about English rules when typing material:</p>
<ul>
-<li><a class="externalLink" href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style">Wikipedia:Manual of Style</a>, specifically <a class="externalLink" href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Punctuation">Punctuation Part</a></li></ul></section></section>
+
+<li><a href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style" class="externalLink">Wikipedia:Manual of Style</a>, specifically <a href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Punctuation" class="externalLink">Punctuation Part</a></li>
+</ul></section></section></section>
</main>
</div>
</div>
Modified: maven/website/content/guides/development/guide-helping.html
==============================================================================
--- maven/website/content/guides/development/guide-helping.html (original)
+++ maven/website/content/guides/development/guide-helping.html Thu Feb 9 00:34:05 2023
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-helping.apt at 2023-02-08
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-helping.md at 2023-02-09
| Rendered using Apache Maven Fluido Skin 1.11.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
@@ -10,10 +10,8 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" />
- <meta name="author" content="Brett Porter
-Jason van Zyl" />
- <meta name="date" content="2008-07-03
-2015-06-16" />
+ <meta name="author" content="Brett Porter, Jason van Zyl" />
+ <meta name="date" content="2008-07-03, 2015-06-16" />
<title>Maven – Guide to helping with Maven</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" />
<link rel="stylesheet" href="../../css/site.css" />
@@ -50,8 +48,8 @@ Jason van Zyl" />
<ul class="breadcrumb">
<li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Guide to helping with Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-helping.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-08</li>
+ <li class="active ">Guide to helping with Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-helping.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-09</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
<li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li>
@@ -135,41 +133,87 @@ Jason van Zyl" />
</div>
</header>
<main id="bodyColumn" class="span10" >
-<section>
-<h1>Guide to helping with Maven</h1>
+<!--
+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.
+-->
+<section><section>
+<h2>Guide to helping with Maven</h2>
<p>As with any open source project, there are several ways you can help:</p>
<ul>
-<li>Join the <a href="../../mailing-lists.html">mailing lists</a> and answer other user's questions.</li>
-<li>Report bugs, feature requests and other issues in the <a href="../../issue-management.html">issue management system</a>.</li>
-<li><a href="./guide-building-maven.html"> Build Maven</a> for yourself, in order to fix bugs.</li>
-<li><a href="./guide-maven-development.html#Creating_and_submitting_a_patch">Submit patches</a> to reported issues (both those you find, or that others have filed)<br />To ease your first contribution, we have a <a class="externalLink" href="https://s.apache.org/for-the-grabs_maven">list of "up for grabs" issues</a>, meaning that they should be easy to work on.</li>
-<li><a href="./guide-testing-releases.html"> test releases</a> help test releases that are being voted on (see the dev@maven.apache.org <a href="../../mailing-lists.html"> mailing list</a> for release votes)</li>
-<li><a href="./guide-testing-development-plugins.html"> test snapshot plugins</a> help test the latest development versions of plugins and report issues</li>
-<li>Help with the documentation by pointing out areas that are lacking or unclear, and if you can, submitting Pull Requests to correct it: use the "edit" button in the breadcrumb, just after the page title. You can also create appropriate issues <a class="externalLink" href="https://issues.apache.org/jira/browse/MNGSITE">by using the issue management system</a>.</li></ul>
+
+<li>
+<p>Join the <a href="../../mailing-lists.html">mailing lists</a> and answer other user's questions.</p></li>
+<li>
+<p>Report bugs, feature requests and other issues in the <a href="../../issue-management.html">issue management system</a>.</p></li>
+<li>
+<p><a href="./guide-building-maven.html">Build Maven</a> for yourself, in order to fix bugs.</p></li>
+<li>
+<p><a href="./guide-maven-development.html#Creating_and_submitting_a_patch">Submit patches</a> to reported issues (both those you find, or that others have filed)<br />
+To ease your first contribution, we have a <a href="https://s.apache.org/for-the-grabs_maven" class="externalLink">list of “up for grabs” issues</a>, meaning that they should be easy to work on.</p></li>
+<li>
+<p><a href="./guide-testing-releases.html">test releases</a> help test releases that are being voted on (see the <a href="mailto:dev@maven.apache.org" class="externalLink">dev@maven.apache.org</a> <a href="../../mailing-lists.html">mailing list</a> for release votes)</p></li>
+<li>
+<p><a href="./guide-testing-development-plugins.html">test snapshot plugins</a> help test the latest development versions of plugins and report issues</p></li>
+<li>
+<p>Help with the documentation by pointing out areas that are lacking or unclear, and if you can, submitting Pull Requests to correct it: use the “edit” button in the breadcrumb, just after the page title. You can also create appropriate issues <a href="https://issues.apache.org/jira/browse/MNGSITE" class="externalLink">by using the issue management system</a>.</p></li>
+</ul>
<p>Your participation in the community is much appreciated!</p></section><section>
-<h1>Why Would I Want to Help?</h1>
+<h2>Why Would I Want to Help?</h2>
<p>There are several reasons these are good things.</p>
<ul>
-<li>By answering other people's questions, you can learn more for yourself</li>
-<li>By submitting your own fixes, they get incorporated faster</li>
-<li>By reporting issues, you ensure that bugs don't get missed, or forgotten</li>
-<li>You are giving back to a community that has given you software for free</li></ul></section><section>
-<h1>How do I Join the Project?</h1>
+
+<li>
+<p>By answering other people's questions, you can learn more for yourself</p></li>
+<li>
+<p>By submitting your own fixes, they get incorporated faster</p></li>
+<li>
+<p>By reporting issues, you ensure that bugs don't get missed, or forgotten</p></li>
+<li>
+<p>You are giving back to a community that has given you software for free</p></li>
+</ul></section><section>
+<h2>How do I Join the Project?</h2>
<p>Projects at Apache operate under a meritocracy, meaning those that the developers notice participating to a high extent will be invited to join the project as a committer.</p>
<p>This is as much based on personality and ability to work with other developers and the community as it is with proven technical ability. Being unhelpful to other users, or obviously looking to become a committer for bragging rights and nothing else is frowned upon, as is asking to be made a committer without having contributed sufficiently to be invited.</p></section><section>
-<h1>Developers Conventions</h1>
+<h2>Developers Conventions</h2>
<p>There are a number of conventions used in the project, which contributors and developers alike should follow for consistency's sake.</p>
<ul>
-<li><a href="../../developers/conventions/code.html">Maven Code Style And Convention</a></li>
-<li><a href="../../developers/conventions/jira.html">Maven Jira Convention</a></li>
-<li><a href="../../developers/conventions/git.html">Maven Git Convention</a></li>
-<li><a href="../../developers/release/index.html">Releasing a Maven project</a></li>
-<li><a class="externalLink" href="https://cwiki.apache.org/confluence/display/MAVEN/Index">Apache Maven Wiki</a></li></ul></section><section>
-<h1>Resources for committers</h1>
+
+<li>
+<p><a href="../../developers/conventions/code.html">Maven Code Style And Convention</a></p></li>
+<li>
+<p><a href="../../developers/conventions/jira.html">Maven Jira Convention</a></p></li>
+<li>
+<p><a href="../../developers/conventions/git.html">Maven Git Convention</a></p></li>
+<li>
+<p><a href="../../developers/release/index.html">Releasing a Maven project</a></p></li>
+<li>
+<p><a href="https://cwiki.apache.org/confluence/display/MAVEN/Index" class="externalLink">Apache Maven Wiki</a></p></li>
+</ul></section><section>
+<h2>Resources for committers</h2>
<ul>
-<li><a class="externalLink" href="http://www.apache.org/dev/"> Developer Resources</a></li>
-<li><a class="externalLink" href="http://www.apache.org/foundation/"> About the Apache Software Foundation</a></li>
-<li><a class="externalLink" href="http://www.apache.org/dev/committers.html"> Committer FAQ</a></li></ul></section>
+
+<li>
+<p><a href="http://www.apache.org/dev/" class="externalLink">Developer Resources</a></p></li>
+<li>
+<p><a href="http://www.apache.org/foundation/" class="externalLink">About the Apache Software Foundation</a></p></li>
+<li>
+<p><a href="http://www.apache.org/dev/committers.html" class="externalLink">Committer FAQ</a></p></li>
+</ul></section></section>
</main>
</div>
</div>
Modified: maven/website/content/guides/development/guide-maven-development.html
==============================================================================
--- maven/website/content/guides/development/guide-maven-development.html (original)
+++ maven/website/content/guides/development/guide-maven-development.html Thu Feb 9 00:34:05 2023
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-maven-development.apt at 2023-02-08
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-maven-development.md at 2023-02-09
| Rendered using Apache Maven Fluido Skin 1.11.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
@@ -10,10 +10,7 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" />
- <meta name="author" content="Emmanuel Venisse
-Trygve Laugstol
-Brett Porter
-Maarten Mulders" />
+ <meta name="author" content="Emmanuel Venisse, Trygve Laugstol, Brett Porter, Maarten Mulders" />
<meta name="date" content="2019-06-04" />
<title>Maven – Guide to Developing Maven</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" />
@@ -51,8 +48,8 @@ Maarten Mulders" />
<ul class="breadcrumb">
<li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Guide to Developing Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-maven-development.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-08</li>
+ <li class="active ">Guide to Developing Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-maven-development.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-09</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
<li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li>
@@ -142,69 +139,119 @@ Maarten Mulders" />
</div>
</header>
<main id="bodyColumn" class="span10" >
-<section>
-<h1>Developing Maven</h1>
+<!--
+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.
+-->
+<section><section>
+<h2>Developing Maven</h2>
<p>This document describes how to get started developing Maven itself. There is a separate page describing how to <a href="./guide-building-maven.html">build Maven</a>.</p><section>
-<h2>Finding some work to do</h2>
+<h3>Finding some work to do</h3>
<p>First of all you need something to work on! Issues can be found in <a href="/issue-management.html">several JIRA projects</a>.</p>
-<p>Another good place to look for work is the <a class="externalLink" href="https://s.apache.org/up-for-grabs_maven"> Up for grabs</a> list. This list contains relatively simple issues that can be worked on without a lot of prerequisite knowledge. </p>
+<p>Another good place to look for work is the <a href="https://s.apache.org/up-for-grabs_maven" class="externalLink">Up for grabs</a> list. This list contains relatively simple issues that can be worked on without a lot of prerequisite knowledge.</p>
<p>When you find a issue you would like to work on, add a comment in the issue log so the core developers and other people looking for work know that someone is already working on it.</p></section><section>
-<h2>Where's the source?</h2>
-<p>See <a href="/scm.html">https://maven.apache.org/scm.html</a> for information. The Maven project uses the Apache GitBox Repositories, and all of them are dual-mirrored to <a class="externalLink" href="https://github.com/apache/"> GitHub</a>.</p></section><section>
-<h2>Don't forget tests!</h2>
+<h3>Where's the source?</h3>
+<p>See <a href="/scm.html">https://maven.apache.org/scm.html</a> for information. The Maven project uses the Apache GitBox Repositories, and all of them are dual-mirrored to <a href="https://github.com/apache/" class="externalLink">GitHub</a>.</p></section><section>
+<h3>Don't forget tests!</h3><!-- TODO move details to guide-building-maven.apt, keep only principles here -->
+
<p>You will find many unit tests. If at all possible, create or modify a unit test to demonstrate the problem, and then validate your fix.</p>
<p>If you need to mock a class to write a test, use the Mockito framework. Parts of the Maven codebase predate Mockito so you will encounter existing tests that use EasyMock, PowerMock, and JMock. However, all newly written mocks should use Mockito, even if this means a module or a single class uses multiple mocking frameworks. If an existing test class has complicated legacy mock setup, you can add new Mockito based tests in a new test class. There is no requirement that all tests for a single model class must be in the same test class. It is OK to have multiple test classes per model class.</p>
<p>If the problem case can't be set up in the unit tests, add an integration test. Before submitting a patch, in any case, you should run all of the integration tests. The tests require an empty local repository. See <a href="/core-its/core-it-suite/">Core IT Suite documentation</a> for more details.</p></section><section>
-<h2><a id="Creating_and_submitting_a_patch">Creating and submitting a patch</a></h2>
+<h3>Creating and submitting a patch</h3>
<p>The most convenient way is to create a GitHub fork from the Git repository you are working with. When you have either completed an issue or just want some feedback on the work you have done, create a pull request. We have a couple of guidelines when submitting contributions:</p>
<ul>
-<li>Verify the status of the <code>master</code> branch on <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool-master-jobs.html">Maven CI</a>. If it is not SUCCCESS, then first try to figure out the problem, don't start with your own issue yet! You can use <code>git bisect</code> to figure out the problematic commit and help with that committer to solve the problem.</li>
-<li>Create your branch from <code>master</code>, not from a tag. Otherwise, your patch is outdated the moment you create it and might not be applicable to the development head.</li>
-<li>If this was a new piece of work without a JIRA issue, create a JIRA issue for it now.</li>
-<li>Name the branch after the issue number; the branch name would start with <code><jira-project-id>-<ticket-id></code>.</li>
-<li>Push your branch with the commit(s) to your fork.</li>
-<li>Create a <a class="externalLink" href="https://help.github.com/en/articles/about-pull-requests"> pull request</a> to submit your contribution. Shortly after, someone will review the pull request and give you feedback on it.</li></ul>
+
+<li>
+<p>Verify the status of the <code>master</code> branch on <a href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool-master-jobs.html" class="externalLink">Maven CI</a>. If it is not SUCCCESS, then first try to figure out the problem, don't start with your own issue yet! You can use <code>git bisect</code> to figure out the problematic commit and help with that committer to solve the problem.</p></li>
+<li>
+<p>Create your branch from <code>master</code>, not from a tag. Otherwise, your patch is outdated the moment you create it and might not be applicable to the development head.</p></li>
+<li>
+<p>If this was a new piece of work without a JIRA issue, create a JIRA issue for it now.</p></li>
+<li>
+<p>Name the branch after the issue number; the branch name would start with <code>\<jira-project-id\>-\<ticket-id\></code>.</p></li>
+<li>
+<p>Push your branch with the commit(s) to your fork.</p></li>
+<li>
+<p>Create a <a href="https://help.github.com/en/articles/about-pull-requests" class="externalLink">pull request</a> to submit your contribution. Shortly after, someone will review the pull request and give you feedback on it.</p></li>
+</ul>
<p>A short note:</p>
<ul>
-<li>Make sure that you follow our code style, see <a href="#Further_Links">Further Links</a>.</li></ul></section><section>
-<h2>Pull request acceptance criteria</h2>
+
+<li>Make sure that you follow our code style, see <a href="Further_Links">Further Links</a>.</li>
+</ul></section><section>
+<h3>Pull request acceptance criteria</h3>
<p>There are a number of criteria that a pull request will be judged on:</p>
<ul>
-<li>Whether it works and does what is intended. This one is probably obvious!</li>
-<li>Whether it fits the spirit of the project. Some pull requests may be rejected as they take the project in a different direction than the current development community has chosen. This is usually discussed on an issue well before a pull request is contributed, so if you are unsure, discuss it there or on the mailing lists first. Feel free to continue discussing it (with new justification) if you disagree, or appeal to a wider audience on the mailing lists.</li>
-<li>Whether it contains tests. It is expected that any pull request relating to functionality will be accompanied by unit tests and/or integration tests. It is strongly desired (and will be requested) for bug fixes too, but will not be the basis for not applying it. At a bare minimum, the change should not decrease the amount of automated test coverage. As a community, we are focusing on increasing the current coverage, as there are several areas that do not receive automated testing.</li>
-<li>Whether it contains documentation. All new functionality needs to be documented for users, even if it is very rough for someone to expand on later. While rough is acceptable, incomplete is not. As with automated testing, as a community we are striving to increase the current coverage of documentation.</li></ul>
+
+<li>
+<p>Whether it works and does what is intended. This one is probably obvious!</p></li>
+<li>
+<p>Whether it fits the spirit of the project. Some pull requests may be rejected as they take the project in a different direction than the current development community has chosen. This is usually discussed on an issue well before a pull request is contributed, so if you are unsure, discuss it there or on the mailing lists first. Feel free to continue discussing it (with new justification) if you disagree, or appeal to a wider audience on the mailing lists.</p></li>
+<li>
+<p>Whether it contains tests. It is expected that any pull request relating to functionality will be accompanied by unit tests and/or integration tests. It is strongly desired (and will be requested) for bug fixes too, but will not be the basis for not applying it. At a bare minimum, the change should not decrease the amount of automated test coverage. As a community, we are focusing on increasing the current coverage, as there are several areas that do not receive automated testing.</p></li>
+<li>
+<p>Whether it contains documentation. All new functionality needs to be documented for users, even if it is very rough for someone to expand on later. While rough is acceptable, incomplete is not. As with automated testing, as a community we are striving to increase the current coverage of documentation.</p></li>
+</ul>
<p>Above all, don't be discouraged. These are the same requirements the current committers should hold each other to as well. And remember, your contributions are always welcome!</p></section><section>
-<h2>Related Projects</h2>
+<h3>Related Projects</h3>
<p>Maven has a few dependencies on other projects:</p>
<ul>
-<li><b>Plexus</b>
+
+<li>
+<p><strong>Plexus</strong></p>
<p>Plexus is a full-fledged container supporting different kinds of component lifecycles. Its native lifecycle is like any other modern IoC container, using field injection of both requirements and configuration. All core Maven functionality are Plexus components.</p>
-<p>You can <a class="externalLink" href="https://codehaus-plexus.github.io/">read more about Plexus</a>.</p></li>
-<li><b>Modello</b>
+<p>You can <a href="https://codehaus-plexus.github.io/" class="externalLink">read more about Plexus</a>.</p></li>
+<li>
+<p><strong>Modello</strong></p>
<p>Modello is a simple tool for representing an object model and generating code and resources from the model. Maven uses Modello to generate all Java objects, XML readers and writers, XML Schema, and HTML documentation.</p>
-<p>You can <a class="externalLink" href="https://codehaus-plexus.github.io/modello/">read more about Modello</a>.</p></li>
-<li><b>Mojo</b>
-<p>"Mojo" is really two things when it comes to Maven: it is both <a href="/ref/current/maven-plugin-api/">Maven's plug-in API</a> and also <a class="externalLink" href="http://www.mojohaus.org">a separate Mojohaus project</a> hosting a lot of plugins.</p>
-<p><a class="externalLink" href="http://www.mojohaus.org">The MojoHaus Project</a> is a plugin forge for non-core Maven plugins. There is also a lower bar for becoming a part of the project.</p></li></ul></section><section>
-<h2>Sub Projects</h2>
+<p>You can <a href="https://codehaus-plexus.github.io/modello/" class="externalLink">read more about Modello</a>.</p></li>
+<li>
+<p><strong>Mojo</strong></p>
+<p>“Mojo” is really two things when it comes to Maven: it is both <a href="/ref/current/maven-plugin-api/">Maven's plug-in API</a> and also <a href="http://www.mojohaus.org" class="externalLink">a separate Mojohaus project</a> hosting a lot of plugins.</p>
+<p><a href="http://www.mojohaus.org" class="externalLink">The MojoHaus Project</a> is a plugin forge for non-core Maven plugins. There is also a lower bar for becoming a part of the project.</p></li>
+</ul></section><section>
+<h3>Sub Projects</h3>
<ul>
-<li><b>Maven Surefire</b>
-<p>Surefire is a testing framework. It can run regular JUnit tests so you won't have to change anything in your code to use it. It supports scripting tests in BeanShell and Jython and has special "batteries" for writing acceptance and functional tests for the web and for testing XML-RPC code.</p>
+
+<li>
+<p><strong>Maven Surefire</strong></p>
+<p>Surefire is a testing framework. It can run regular JUnit tests so you won't have to change anything in your code to use it. It supports scripting tests in BeanShell and Jython and has special “batteries” for writing acceptance and functional tests for the web and for testing XML-RPC code.</p>
<p>You can <a href="/surefire/">read more about Surefire</a>.</p></li>
-<li><b>Maven Doxia</b>
+<li>
+<p><strong>Maven Doxia</strong></p>
<p>Doxia is Maven's documentation engine. It has a sink and parser API that can be used to plug in support for input and output documents.</p>
<p>You can read more about <a href="/doxia/">Doxia</a> and the currently supported <a href="/doxia/references/index.html">document formats</a>.</p></li>
-<li><b>Maven SCM</b>
+<li>
+<p><strong>Maven SCM</strong></p>
<p>Maven SCM (Source Control Management) is a reusable API which is independent of Maven itself. It is used by the SCM related Maven Plugins. The core part of Maven doesn't depend on Maven SCM.</p>
<p>You can <a href="/scm/">read more about Scm</a>.</p></li>
-<li><b>Maven Wagon</b>
+<li>
+<p><strong>Maven Wagon</strong></p>
<p>Maven Wagon is a standalone API that dealt with transporting files and directories in Maven 2.x. Maven Core today uses the Resolver Transport API, that among other implementations, contains a wrapper for Wagon as well. Also, the site plug-in uses it to publish the site.</p>
-<p>You can <a href="/wagon/">read more about Wagon</a>.</p></li></ul></section><section>
-<h2><a id="Further_Links">Further Links</a></h2>
+<p>You can <a href="/wagon/">read more about Wagon</a>.</p></li>
+</ul></section><section>
+<h3>Further Links</h3>
<ul>
-<li><a href="../../developers/conventions/code.html">Maven Code Style And Code Convention</a></li>
-<li><a href="../../developers/conventions/jira.html">Maven JIRA Convention</a></li></ul></section></section>
+
+<li>
+<p><a href="../../developers/conventions/code.html">Maven Code Style And Code Convention</a></p></li>
+<li>
+<p><a href="../../developers/conventions/jira.html">Maven JIRA Convention</a></p></li>
+</ul></section></section></section>
</main>
</div>
</div>
Modified: maven/website/content/guides/development/guide-plugin-documentation.html
==============================================================================
--- maven/website/content/guides/development/guide-plugin-documentation.html (original)
+++ maven/website/content/guides/development/guide-plugin-documentation.html Thu Feb 9 00:34:05 2023
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-plugin-documentation.apt at 2023-02-08
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-plugin-documentation.md at 2023-02-09
| Rendered using Apache Maven Fluido Skin 1.11.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
@@ -48,8 +48,8 @@
<ul class="breadcrumb">
<li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Guide to the Plugin Documentation Standard <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-plugin-documentation.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-08</li>
+ <li class="active ">Guide to the Plugin Documentation Standard <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-plugin-documentation.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-09</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
<li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li>
@@ -123,47 +123,88 @@
</div>
</header>
<main id="bodyColumn" class="span10" >
-<section>
-<h1>Introduction</h1><section>
-<h2>Where did the standard come from?</h2>
-<p>The plugin documentation standard was created to address the frequent complain of lack of documentation, specifically on the Maven plugins. The standard was based on the suggestions made on the Maven dev mailing list with some refinements. It is a community consensus of what basic documentation a Maven plugin should have. </p></section><section>
-<h2>Why do we need a documentation standard?</h2>
+<!--
+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.
+-->
+<section><section>
+<h2>Introduction</h2><section>
+<h3>Where did the standard come from?</h3>
+<p>The plugin documentation standard was created to address the frequent complain of lack of documentation, specifically on the Maven plugins. The standard was based on the suggestions made on the Maven dev mailing list with some refinements. It is a community consensus of what basic documentation a Maven plugin should have.</p></section><section>
+<h3>Why do we need a documentation standard?</h3>
<p>The standard is not a set of rules but a guide to help plugin developers document their plugins better, for the benefit of the users of the plugin. The standard also reminds the plugin developers of the important details that needs to be documented, to help speed up the adoption of the plugin.</p></section></section><section>
-<h1>Generated Documentation </h1>
-<p>It is recommended that you let Maven generate the basic information for the plugin to make sure that that the basic information is always accurate and synchronized with the plugin implementation. </p>
-<p>Documentation is generated by running </p>
-<div>
-<pre>mvn site</pre></div>
+<h2>Generated Documentation</h2>
+<p>It is recommended that you let Maven generate the basic information for the plugin to make sure that that the basic information is always accurate and synchronized with the plugin implementation.</p>
+<p>Documentation is generated by running</p>
+
+<div class="source"><pre class="prettyprint linenums"><code>mvn site
+</code></pre></div>
<p>It will generate a plugin site based on the information in the POM, <code>src/site</code> and other reporting plugins configured in the POM. The most important reporting plugin is the <a href="/plugins/maven-plugin-plugin/">Maven Plugin Plugin</a> which will generate the documentation for each plugin goal based on the mojo annotations. But in order for the generated site to be usable, the required information should be available to the Maven Site Plugin.</p><section>
-<h2>POM Elements</h2>
+<h3>POM Elements</h3>
<p>Maven extracts the information from the POM to generate the pages under Project Information. The first step in having a good documentation is to have an accurate and visible basic project information, Maven can provide this for the plugin as long as the information in the POM is complete, descriptive and accurate.</p><section>
-<h3>Required Elements</h3>
+<h4>Required Elements</h4>
<p>Minimum elements for a valid POM:</p>
<ul>
-<li><code><modelVersion></code> - POM model version, currently 4.0.0</li>
-<li><code><groupId></code> - the package name</li>
-<li><code><artifactId></code> - artifact name</li>
-<li><code><packaging></code> - type of artifact produced by the POM</li>
-<li><code><version></code> - the plugin version</li></ul></section><section>
-<h3>Optional Elements </h3>
+
+<li>
+<p><code>\<modelVersion\></code> - POM model version, currently 4.0.0</p></li>
+<li>
+<p><code>\<groupId\></code> - the package name</p></li>
+<li>
+<p><code>\<artifactId\></code> - artifact name</p></li>
+<li>
+<p><code>\<packaging\></code> - type of artifact produced by the POM</p></li>
+<li>
+<p><code>\<version\></code> - the plugin version</p></li>
+</ul></section><section>
+<h4>Optional Elements</h4>
<p>These might be optional elements in a valid POM but they are important basic project information required by the users to effectively use the plugin:</p>
<ul>
-<li><code><name></code> - plugin's name, <i>Maven NNN Plugin</i> for plugins hosted at the Maven project or <i>NNN Maven Plugin</i> for all others</li>
-<li><code><description></code> - project description, an overview of what the plugin can do</li>
-<li><code><url></code> - the site of the plugin, normally <i>maven.apache.org</i> or <i>org.mojohaus</i></li>
-<li><code><prerequisites></code> - the minimum version of Maven required to use this plugin</li>
-<li><code><issueManagement></code> - describes the system used for reporting problems and modification requests
-<div class="source"><pre class="prettyprint linenums"><project>
+
+<li>
+<p><code>\<name\></code> - plugin's name, <em>Maven NNN Plugin</em> for plugins hosted at the Maven project or <em>NNN Maven Plugin</em> for all others</p></li>
+<li>
+<p><code>\<description\></code> - project description, an overview of what the plugin can do</p></li>
+<li>
+<p><code>\<url\></code> - the site of the plugin, normally <em>maven.apache.org</em> or <em>org.mojohaus</em></p></li>
+<li>
+<p><code>\<prerequisites\></code> - the minimum version of Maven required to use this plugin</p></li>
+<li>
+<p><code>\<issueManagement\></code> - describes the system used for reporting problems and modification requests</p></li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
[...]
<issueManagement>
<system>jira</system>
<url>http://jira.someproject.org</url>
</issueManagement>
[...]
-</project></pre></div></li>
-<li><code><inceptionYear></code> - year the plugin was first created</li>
-<li><code><mailingLists></code> - lists where other users or the developers can be contacted for help and discussions
-<div class="source"><pre class="prettyprint linenums"><project>
+</project>
+</code></pre></div>
+<ul>
+
+<li>
+<p><code>\<inceptionYear\></code> - year the plugin was first created</p></li>
+<li>
+<p><code>\<mailingLists\></code> - lists where other users or the developers can be contacted for help and discussions</p></li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
[...]
<mailingLists>
<mailingList>
@@ -178,9 +219,14 @@
</mailingList>
</mailingLists>
[...]
-</project></pre></div></li>
-<li><code><licenses></code> - plugin license
-<div class="source"><pre class="prettyprint linenums"><project>
+</project>
+</code></pre></div>
+<ul>
+
+<li><code>\<licenses\></code> - plugin license</li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
[...]
<licenses>
<license>
@@ -190,9 +236,14 @@
</license>
</licenses>
[...]
-</project></pre></div></li>
-<li><code><scm></code> - the source code management configuration - a plugin without this would raise suspicion, might not be OSS
-<div class="source"><pre class="prettyprint linenums"><project>
+</project>
+</code></pre></div>
+<ul>
+
+<li><code>\<scm\></code> - the source code management configuration - a plugin without this would raise suspicion, might not be OSS</li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
[...]
<scm>
<connection>scm:svn:http://noonecares.com/some/plugin/project/trunk</connection>
@@ -200,19 +251,26 @@
<url>http://noonecares.com/viewvc/some/project/trunk/</url>
</scm>
[...]
-</project></pre></div></li>
-<li><code><organization></code> - the organization maintaining the plugin, just in case we need someone to blame
-<div class="source"><pre class="prettyprint linenums"><project>
+</project>
+</code></pre></div>
+<ul>
+
+<li><code>\<organization\></code> - the organization maintaining the plugin, just in case we need someone to blame</li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
[...]
<organization>
<name>Noone Care Software Foundation</name>
<url>http://noonecare.org/</url>
</organization>
[...]
-</project></pre></div></li></ul></section></section><section>
-<h2>Plugin Configuration Parameters</h2>
-<p>The Maven Plugin Plugin is responsible for generating the Plugin Info site and needs to be added to the <code><reporting></code> section unless it is already inherited from a parent POM:</p>
-<div class="source"><pre class="prettyprint linenums"><project>
+</project>
+</code></pre></div></section></section><section>
+<h3>Plugin Configuration Parameters</h3>
+<p>The Maven Plugin Plugin is responsible for generating the Plugin Info site and needs to be added to the <code>\<reporting\></code> section unless it is already inherited from a parent POM:</p>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
[...]
<reporting>
<plugins>
@@ -224,20 +282,29 @@
</plugins>
</reporting>
[...]
-</project></pre></div>
+</project>
+</code></pre></div>
<p>The comments, annotations and plugin parameter names are extracted from the plugin source and rendered in the Plugin Info page. In order for the generated site to be useful here are some guidelines you can follow when documenting your plugin.</p>
<ul>
-<li>all <code>@parameter</code> fields should have a descriptive comment, informative enough that even a regular user can understand
-<div class="source"><pre class="prettyprint linenums"> [...]
+
+<li>all <code>@parameter</code> fields should have a descriptive comment, informative enough that even a regular user can understand</li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code> [...]
/**
* Put something informative here that a regular user can understand.
*
* @parameter
*/
private boolean someparameter;
- [...]</pre></div></li>
-<li>class level comment should explain what the goal does
-<div class="source"><pre class="prettyprint linenums">[...]
+ [...]
+</code></pre></div>
+<ul>
+
+<li>class level comment should explain what the goal does</li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code>[...]
/**
* Everything here will show up on the top of the generated plugin info page.
*
@@ -250,13 +317,18 @@ public class ExampleMojo
public void execute()
throws MojoExecutionException, MojoFailureException
{
-[...]</pre></div></li>
-<li>the <code>@component</code> and <code>@readonly</code> parameters are not required to have any comments but it's still a good practice to provide one</li></ul></section><section>
-<h2>Site Organization </h2>
-<p>Visibility of the information is also crucial, having uniform navigation links will greatly improve the visibility of the documentations. The index page can also help emphasize important sections and pages of the plugin documentation. </p><section>
-<h3>Site Descriptor </h3>
+[...]
+</code></pre></div>
+<ul>
+
+<li>the <code>@component</code> and <code>@readonly</code> parameters are not required to have any comments but it's still a good practice to provide one</li>
+</ul></section><section>
+<h3>Site Organization</h3>
+<p>Visibility of the information is also crucial, having uniform navigation links will greatly improve the visibility of the documentations. The index page can also help emphasize important sections and pages of the plugin documentation.</p><section>
+<h4>Site Descriptor</h4>
<p>The site descriptor describes the navigation links and can be found in <code>src/site/site.xml</code>. Below is the suggested site descriptor template.</p>
-<div class="source"><pre class="prettyprint linenums"><?xml version="1.0" encoding="UTF-8"?>
+
+<div class="source"><pre class="prettyprint linenums"><code><?xml version="1.0" encoding="UTF-8"?>
<project>
<body>
<menu name="Overview">
@@ -271,13 +343,17 @@ public class ExampleMojo
<item name="description2" href="examples/example-two.html"/>
</menu>
</body>
-</project></pre></div><section>
-<h4>Navigation Links</h4>
+</project>
+</code></pre></div><section>
+<h5>Navigation Links</h5>
<ul>
-<li>Introduction
-<p>The introduction is the front page of the plugin documentation. This is a good place to place any section and pages that needs to be emphasized. It is also suggested that the generated plugin parameter configuration be linked here. Below is the suggested <code>src/site/apt/index.apt</code> template</p>
-<div>
-<pre> ------
+
+<li>
+<p>Introduction</p>
+<p>The introduction is the front page of the plugin documentation. This is a good place to place any section and pages that needs to be emphasized. It is also suggested that the generated plugin parameter configuration be linked here. Below is the suggested <code>src/site/apt/index.apt</code> template</p></li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code> ------
Introduction
------
Author
@@ -324,14 +400,22 @@ Plugin Name
* {{{./examples/example-one.html}Example Description One}}
* {{{./examples/example-two.html}Example Description Two}}
- </pre></div></li>
-<li>Goals
-<p><code>plugin-info.html</code> is generated by the Maven Plugin Plugin. Until the Maven Site Plugin is updated it would be better to pull it out to the main menu for greater visibility. This contains the goals and their descriptions with a link to the configuration parameters. The information is based on the comments and annotations of the plugin. </p></li>
-<li>Usage (this was previously called Howto)
-<p>The usage page describes the the basic use cases for the plugin goals which includes sample POM configurations and explanation of how the goals work. </p></li>
-<li>FAQ
-<p>A well documented project always collates frequently asked questions which are usually located in <code>src/site/fml/faq.fml</code>. The example below provides a template for your FAQ:</p>
-<div class="source"><pre class="prettyprint linenums"><?xml version="1.0" encoding="UTF-8"?>
+
+</code></pre></div>
+<ul>
+
+<li>
+<p>Goals</p>
+<p><code>plugin-info.html</code> is generated by the Maven Plugin Plugin. Until the Maven Site Plugin is updated it would be better to pull it out to the main menu for greater visibility. This contains the goals and their descriptions with a link to the configuration parameters. The information is based on the comments and annotations of the plugin.</p></li>
+<li>
+<p>Usage (this was previously called Howto)</p>
+<p>The usage page describes the the basic use cases for the plugin goals which includes sample POM configurations and explanation of how the goals work.</p></li>
+<li>
+<p>FAQ</p>
+<p>A well documented project always collates frequently asked questions which are usually located in <code>src/site/fml/faq.fml</code>. The example below provides a template for your FAQ:</p></li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code><?xml version="1.0" encoding="UTF-8"?>
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="question">
@@ -343,20 +427,30 @@ Plugin Name
</answer>
</faq>
</part>
-</faqs></pre></div></li>
-<li>Examples
-<p>The advanced configurations and examples not covered in the usage page is located here. Advanced users who wants to maximize the use of a plugin can check the items here. Tips on how to use the plugin effectively is also a good thing to put here.</p>
-<p>For examples of items under "Examples" check these plugin sites:</p>
+</faqs>
+</code></pre></div>
<ul>
-<li><a href="/plugins/maven-javadoc-plugin/">Maven Javadoc Plugin Examples</a></li>
-<li><a href="/plugins/maven-war-plugin/">Maven War Plugin Examples</a></li></ul></li></ul></section></section></section><section>
-<h2>Recommended Configured Reports</h2>
+
+<li>
+<p>Examples</p>
+<p>The advanced configurations and examples not covered in the usage page is located here. Advanced users who wants to maximize the use of a plugin can check the items here. Tips on how to use the plugin effectively is also a good thing to put here.</p>
+<p>For examples of items under “Examples” check these plugin sites:</p></li>
+<li>
+<p><a href="/plugins/maven-javadoc-plugin/">Maven Javadoc Plugin Examples</a></p></li>
+<li>
+<p><a href="/plugins/maven-war-plugin/">Maven War Plugin Examples</a></p></li>
+</ul></section></section></section><section>
+<h3>Recommended Configured Reports</h3>
<p>There are 2 recommended report plugins to enhance the plugin documentation, Javadoc and JXR.</p>
<ul>
-<li>Maven Javadoc Plugin
+
+<li>
+<p>Maven Javadoc Plugin</p>
<p>Javadocs provide documentation that makes it easier for developers to know how to use a particular class. Instead of reading and understanding the actual source code, the developer can use the Javadocs instead to lookup the class attributes and methods.</p>
-<p>To enable javadoc for your plugin add the following to your <code>pom.xml</code></p>
-<div class="source"><pre class="prettyprint linenums"><project>
+<p>To enable javadoc for your plugin add the following to your <code>pom.xml</code></p></li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
[...]
<build>
[...]
@@ -377,12 +471,18 @@ Plugin Name
[...]
</reporting>
[...]
-</project></pre></div>
-<p>Check the documentation about the plugin's <a href="/plugins/maven-javadoc-plugin/javadoc-mojo.html"><code>javadoc:javadoc</code></a> goal for the advanced configurations.</p></li>
-<li>Maven JXR Plugin
+</project>
+</code></pre></div>
+<p>Check the documentation about the plugin's <a href="/plugins/maven-javadoc-plugin/javadoc-mojo.html"><code>javadoc:javadoc</code></a> goal for the advanced configurations.</p>
+<ul>
+
+<li>
+<p>Maven JXR Plugin</p>
<p>The Maven JXR Plugin generates a cross-reference of the project sources. The generated cross-references are also linked to the corresponding javadoc if javadoc is generated. The cross-references is great for those who wants to better understand the inner workings of the plugin.</p>
-<p>To enable source code cross-references add the following to your <code>pom.xml</code></p>
-<div class="source"><pre class="prettyprint linenums"><project>
+<p>To enable source code cross-references add the following to your <code>pom.xml</code></p></li>
+</ul>
+
+<div class="source"><pre class="prettyprint linenums"><code><project>
[...]
<build>
[...]
@@ -397,8 +497,9 @@ Plugin Name
</plugins>
</reporting>
[...]
-</project></pre></div>
-<p>Check the <a href="/plugins/maven-jxr-plugin/jxr-mojo.html">JXR configuration page</a> for the possible configuration parameters.</p></li></ul></section></section>
+</project>
+</code></pre></div>
+<p>Check the <a href="/plugins/maven-jxr-plugin/jxr-mojo.html">JXR configuration page</a> for the possible configuration parameters.</p></section></section></section>
</main>
</div>
</div>