[jira] [Commented] (ACCUMULO-1487) Package javadocs for monitor better, or not at all

["ASF subversion and git services (JIRA)" <ji...@apache.org>]

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

ASF subversion and git services commented on ACCUMULO-1487:
-----------------------------------------------------------

Commit a20e19fc4f7c7989ba1b50459d9f762063e3e631 in accumulo's branch refs/heads/1.6.0-SNAPSHOT from [~ctubbsii]
[ https://git-wip-us.apache.org/repos/asf?p=accumulo.git;h=a20e19f ]

ACCUMULO-1487, ACCUMULO-1491 Stop packaging docs for monitor

Moved docs out of monitor and into docs directory. Added docs to assemblies.
Remove unnecessary goals from release profile. Remove links from docs to
apidocs. Restricted rpms/debs from being placed in lib/ and docs/ in tarball.


> 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: Sub-task
>          Components: docs
>            Reporter: Christopher Tubbs
>            Assignee: Christopher Tubbs
>              Labels: Documentation
>             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 was sent by Atlassian JIRA
(v6.2#6252)