accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Busbey (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-1487) Package javadocs for monitor better, or not at all
Date Mon, 03 Jun 2013 23:46:20 GMT

    [ https://issues.apache.org/jira/browse/ACCUMULO-1487?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13673795#comment-13673795
] 

Sean Busbey commented on ACCUMULO-1487:
---------------------------------------

+1 Option 3. 

The main use case for packaging the javadocs is providing a local mirror. That made sense
pre-Apache, but now they're readily available provided you can access the website.

The only big win with packaging is making sure a user is looking at the correct version, but
the link effectively gives us that.
                
> Package javadocs for monitor better, or not at all
> --------------------------------------------------
>
>                 Key: ACCUMULO-1487
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-1487
>             Project: Accumulo
>          Issue Type: Improvement
>            Reporter: Christopher Tubbs
>             Fix For: 1.6.0
>
>
> Packaging javadocs are problematic for the monitor page because we need to do something
like:
> {code}mvn clean compile javadoc:aggregate package{code}
> 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:
> # 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).
> # 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.
> # 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).

--
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

Mime
View raw message