Details
-
Improvement
-
Status: Closed
-
Minor
-
Resolution: Fixed
-
3.3
-
None
Description
The site:stage goal would benefit from enhanced documentation.
Firstly, the summary, http://maven.apache.org/plugins/maven-site-plugin/plugin-info.html, is not clear about the need to run "mvn site" before "mvn site:stage". Add the sentence "This goal requires the site to already have been generated using the site goal, such as by calling "mvn site".
Secondly, there needs to be an expansion of the documentation for multi-module/reactor builds to give examples of the complete set of values needed to make it work http://maven.apache.org/plugins/maven-site-plugin/examples/multimodule.html .
Since there are multiple different multi-module project layouts (separate aggregator/parent vs same aggregator/parent, aggregator contains parent etc), this is likely to need multiple examples. The examples should focus on the right settings to use for fields such as distribution.site.url (and the fact that distribution.site.id is also mandatory).