Stephen Colebourne created MSITE-688:
----------------------------------------
Summary: Enhance site:stage documentation
Key: MSITE-688
URL: https://jira.codehaus.org/browse/MSITE-688
Project: Maven 2.x and 3.x Site Plugin
Issue Type: Improvement
Components: site:stage(-deploy)
Affects Versions: 3.3
Reporter: Stephen Colebourne
Priority: Minor
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).
--
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
