You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@accumulo.apache.org by "Christopher Tubbs (JIRA)" <ji...@apache.org> on 2016/02/28 06:57:18 UTC

[jira] [Created] (ACCUMULO-4155) Create profile to limit javadoc:aggregate to public API for site docs

Christopher Tubbs created ACCUMULO-4155:
-------------------------------------------

             Summary: 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)