accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-4155) Create profile to limit javadoc:aggregate to public API for site docs
Date Sun, 28 Feb 2016 06:00:24 GMT

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

ASF GitHub Bot commented on ACCUMULO-4155:
------------------------------------------

GitHub user ctubbsii opened a pull request:

    https://github.com/apache/accumulo/pull/78

    ACCUMULO-4155 Limit javadoc:aggregate to public API

    This PR is a preview for review. If acceptable, I'll backport this fix to the 1.6 and
1.7 branches, and update the website with the smaller document set for the latest releases.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/ctubbsii/accumulo limit-javadocs

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/accumulo/pull/78.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #78
    
----
commit 9933a1a0f5bcb0af0d4a90cad525773ba2d6f265
Author: Christopher Tubbs <ctubbsii@apache.org>
Date:   2016-02-28T05:43:55Z

    ACCUMULO-4155 Limit javadoc:aggregate to public API

----


> Create profile to limit javadoc:aggregate to public API for site docs
> ---------------------------------------------------------------------
>
>                 Key: ACCUMULO-4155
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-4155
>             Project: Accumulo
>          Issue Type: Improvement
>          Components: build, website
>            Reporter: Christopher Tubbs
>            Assignee: Christopher Tubbs
>             Fix For: 1.6.6, 1.7.2, 1.8.0
>
>
> The javadocs are of limited value to publish on the website. They are probably best served
in the javadoc jars, for developers building against Accumulo as a dependency.
> However, there is probably some additional value in continuing to publish the javadocs
for the documented public API.
> Additionally, publishing the full aggregated javadocs to the website takes a very long
time (particularly with the website currently on SVN... last time it took me nearly 2 hours
to upload them), and takes up a lot of space (between 150MB and 200MB per release), and mitigating
this with extpaths introduces extra steps during a release which are less than foolproof.
> Limiting the publication to only the public API will reduce the total space to less than
10MB uncompressed, and less than 1MB compressed. This should be enough to eliminate the extpaths
steps entirely, and will reduce the clutter, exposing the public API even more on the site
which will increase the value we get from publishing these javadocs.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message