Corrections for site documentation
----------------------------------
Key: MSCMCHGLOG-4
URL: http://jira.codehaus.org/browse/MSCMCHGLOG-4
Project: Maven 2.x SCM Changelog Plugin
Issue Type: Bug
Reporter: Emmanuel Hugonnet
Priority: Minor
Remarks by Benjamin Bentmann on mojo-dev mailing list :
The POM declares <repositories> and <pluginRepositories> to the Codehaus
snapshot repo. Unless there is some need for those that I miss, these should be
deleted. Releases shouldn't depend on snapshots and artifacts on central
shouldn't require other repos.
The <version> and <publishDate> could be deleted from the site.xml to better
integrate with the Mojo layout (these fields are inherited from the Mojo
parent).
It would promote best practices if the usage.xml and example.xml showed a
version number for the plugin definition in the POM snippets. It doesn't need
to point at the latest release but it's always a frustration for users if they
copy&paste an example snippet to find out it's no longer working because the
snippet was created for another plugin version as they just downloaded.
The second POM snippet in the example.xml has a typo in the plugin's artifactId
(missing initial "s").
For a future release, you could consider to adopt the Plugin Documentation
Standard [0] for the index page.
Benjamin
[0] http://maven.apache.org/guides/development/guide-plugin-documentation.html
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email
