[MSITE-578] Incorrect and confusing documentation of site directories

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.2, 3.0-beta-3
• Fix Version/s: 2.3, 3.0
• Component/s: site:stage(-deploy)
• Assignee: Lukas Theussl
• Reporter: Sebb
• Created: 06/Apr/11 17:12
• Updated: 07/Apr/15 18:54
• Resolved: 07/Apr/11 05:21

Description

The site:stage goal contains the following doc:

generatedSiteDirectory:

Directory containing generated documentation.

• Type: java.io.File
• Required: Yes
• Expression: ${project.build.directory}/generated-site

The expression looks wrong.

The explanation is also a bit ambiguous - is the directory used to find already generated documentation, or is it used as the output directory from site:stage? In which case, how does it differ from outputDirectory ?

The page also contains:

outputDirectory:

Directory containing the generated project sites and report distributions.

• Type: java.io.File
• Required: Yes
• Expression: ${siteOutputDirectory}
• Default: ${project.reporting.outputDirectory}

Again, it's not obvious if this is an output or input directory.

Also, why is the parameter marked as "Required" when there is a default?