[ACCUMULO-1487] Package javadocs for monitor better, or not at all

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.6.0
• Component/s: docs
• Labels: Documentation
• Assignee: Christopher Tubbs
• Reporter: Christopher Tubbs
• Created: 03/Jun/13 15:40
• Updated: 08/Apr/14 03:03
• Resolved: 28/Mar/14 00:54

Description

Packaging javadocs are problematic for the monitor page because we need to do something like:

mvn clean compile javadoc:aggregate package

so the classes are compiled prior to building the javadocs (for some reason, this is a requirement), and the javadocs are available to be packaged when the monitor is packaged. However, this essentially duplicates the build lifecycle between the initialize and compile phase.

Options:

1. Use maven-invoker-plugin to execute the "mvn compile javadoc:aggregate" separately, with minimal plugins configured (not sure the effect this will have on maven-release-plugin which also executes maven-invoker-plugin).
2. Make monitor depend on javadoc artifacts from other modules, and serve them (repackaging, if necessary). This might require javadoc artifacts to be built whenever the monitor is built, and not just during a release.
3. My preferred option: don't package javadocs with the monitor. Instead, link to the Accumulo website (with a configurable base address, to support environments where javadocs are mirrored, in case they can't directly access the Apache website).