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 sv...@apache.org on 2021/07/01 11:55:07 UTC
svn commit: r1891182 - in /maven/website/content: maven-site-1.0-site.jar
pom.html
Author: svn-site-role
Date: Thu Jul 1 11:55:07 2021
New Revision: 1891182
Log:
Site checkin for project Apache Maven Site
Modified:
maven/website/content/maven-site-1.0-site.jar
maven/website/content/pom.html
Modified: maven/website/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.
Modified: maven/website/content/pom.html
==============================================================================
--- maven/website/content/pom.html (original)
+++ maven/website/content/pom.html Thu Jul 1 11:55:07 2021
@@ -1012,14 +1012,14 @@ Display parameters as parsed by Maven (i
</reporting>
...
</project></pre></div>
-<p>Between build <code>executions</code> and reporting <code>reportSets</code>, it should be clear now as to why they exist. In the simplest sense, they drill down in configuration. The POM must have a way not only to configure plugins, but they also must configure individual goals of those plugins. That is where these elements come in, giving the POM ultimate granularity in control of its build destiny.</p></section></section></section><section>
+<p>Between build <code>executions</code> and reporting <code>reportSets</code>, it should be clear now as to why they exist. In the simplest sense, they drill down in configuration. The POM must have a way not only to configure plugins, but must also configure the goals of those plugins. That is where these elements come in, giving the POM ultimate granularity in control of its build destiny.</p></section></section></section><section>
<h2><a name="More_Project_Information">More Project Information</a></h2>
-<p>Although the above information is enough to get a firm grasp on POM authoring, there are far more elements to make developer's live easier. Many of these elements are related to site generation, but like all POM declarations, they may be used for anything, depending upon how certain plugins use it. The following are the simplest elements:</p>
+<p>Several elements do not affect the build, but rather document the project for the convenience of developers. Many of these elements are used to fill in project details when generating the project's web site. However, like all POM declarations, plugins can use them for anything. The following are the simplest elements:</p>
<ul>
<li><b>name</b>: Projects tend to have conversational names, beyond the <code>artifactId</code>. The Sun engineers did not refer to their project as "java-1.5", but rather just called it "Tiger". Here is where to set that value.</li>
-<li><b>description</b>: Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful.</li>
-<li><b>url</b>: The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives.</li>
-<li><b>inceptionYear</b>: This is another good documentation point. It will at least help you remember where you have spent the last few years of your life.</li></ul><section>
+<li><b>description</b>: A short, human readable description of the project. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful.</li>
+<li><b>url</b>: The project's home page.</li>
+<li><b>inceptionYear</b>: The year the project was first created. </li></ul><section>
<h3><a name="Licenses">Licenses</a></h3>
<div class="source"><pre class="prettyprint linenums"><licenses>
<license>