[jira] (MSITE-689) Enhance "configuring reports" documentation

["Stephen Colebourne (JIRA)" <ji...@codehaus.org>]

Stephen Colebourne created MSITE-689:
----------------------------------------

             Summary: Enhance "configuring reports" documentation
                 Key: MSITE-689
                 URL: https://jira.codehaus.org/browse/MSITE-689
             Project: Maven 2.x and 3.x Site Plugin
          Issue Type: Improvement
          Components: documentation
    Affects Versions: 3.3
            Reporter: Stephen Colebourne
            Priority: Minor


Since maven 3 changed and then reverted the way that reports should be customized, it is very hard to find a complete and accurate example of what is now the correct customization of reports and what can be defined where. This page, http://maven.apache.org/plugins/maven-site-plugin/examples/configuring-reports.html, is a start, but needs enhancing.

1) If you want to run javadoc/checkstyle/etc in both the main build and the site plugin, where should the config be? Build or reporting or both?

2) Do the reporting plugins choose aggregating reports automatically if running in a reactor, or do they have to be configured? The current example suggests extra config is needed.

3) If a parent pom defines a reporting block and the same plugin is overridden in a child of that parent pom, what happens? What if the child is an aggregator?

4) Examples, or links, to common reporting plugins (checkstyle/pmd/javadoc) are also needed as they all appear to vary subtly.

Ultimately, it should be possible to go to the page, decide what example matches your project structure, and copy/amend from that specific example.


--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira