You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Tim Stewart (Jira)" <ji...@apache.org> on 2020/05/14 23:05:00 UTC
[jira] [Created] (MNGSITE-410) on website, Maven Getting Started
page, sample pom.xml has no description element, but explanation of pom.xml
thinks it does
Tim Stewart created MNGSITE-410:
-----------------------------------
Summary: on website, Maven Getting Started page, sample pom.xml has no description element, but explanation of 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
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)