Creating a (staged) Documentation site for Nazgul Framework: Tools
Maven’s Site Plugin is a nifty, powerful and rather complex plugin, which generates much required documentation for Maven reactor builds. The site plugin is configured for somewhat sensible default values within the Nazgul Tools reactor. These defaults - and how to change them to match your requirements - are shown below.
What’s a staged Documentation site?
A staged site is maven vocabulary for documentation aggregated from several projects, related to one another by existing within a multi-project maven reactor. The Nazgul Framework: Tools and Nazgul Framework: Core are two examples of multi-project reactors which contain documentation intended for staging.
Building the Documentation site
Maven normally builds documentation sites using the standard commands
mvn site mvn site:stage
These commands are assumed to be executed in the top directory of the maven build reactor. When executed from the Nazgul Tools root directory, these commands produce the staged site in the directory /tmp/nazgul_tools/Documentation/${project.version}, where ${project.version} is substituted for the actual version of the Nazgul Tools reactor.
Changing the local staging directory
Add the parameter site.staging.localDirectory to the stage command to make the staged site appear in another directory:
mvn site mvn site:stage -Dsite.staging.localDirectory=/another/location
Again, these commands are assumed to be executed in the top directory of the maven build reactor. When executed from the Nazgul Tools root directory, these commands produce the staged site in the directory /another/location/Documentation/${project.version}, where ${project.version} is substituted for the actual version of the Nazgul Tools reactor.
If you feel the need to deploy the Nazgul Framework: Tools staged documentation to a remote server, the process is doable, but a tad more complex.