[Closed] (MNGSITE-410) on website, Maven Getting Started page, sample pom.xml has no description element, but subsequent explanation of the sample pom.xml thinks it does

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[Closed] (MNGSITE-410) on website, Maven Getting Started page, sample pom.xml has no description element, but subsequent explanation of the sample pom.xml thinks it does

Tibor Digana (Jira)

     [ https://issues.apache.org/jira/browse/MNGSITE-410?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Sylwester Lachiewicz closed MNGSITE-410.
----------------------------------------
    Resolution: Fixed

> on website, Maven Getting Started page, sample pom.xml has no description element, but subsequent explanation of the sample pom.xml thinks it does
> --------------------------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: MNGSITE-410
>                 URL: https://issues.apache.org/jira/browse/MNGSITE-410
>             Project: Maven Project Web Site
>          Issue Type: Bug
>         Environment: website
>            Reporter: Tim Stewart
>            Priority: Minor
>
> On web page [https://maven.apache.org/guides/getting-started/] the sample pom.xml does not contain a <description> element, but below the sample pom.xml it says: "This is a very simple POM but still displays the key elements every POM contains, so let's walk through each of them to familiarize you with the POM essentials: ... • _description This element provides a basic description of your project. This is often used in Maven's generated documentation._"
> So the explanation of the "description" element assumes the pom.xml contains one, but it does not.
> Recommended fix: include a "description" element in the sample pom.xml. Or, alternatively, remove references to the description "element" from the bulleted explanation of elements below the sample pom.xml



--
This message was sent by Atlassian Jira
(v8.3.4#803005)