Uploaded image for project: 'Accumulo'
  1. Accumulo
  2. ACCUMULO-4155

Create profile to limit javadoc:aggregate to public API for site docs

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.6.6, 1.7.2, 1.8.0
    • Component/s: build, website
    • Labels:
      None

      Description

      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.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                ctubbsii Christopher Tubbs
                Reporter:
                ctubbsii Christopher Tubbs
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 40m
                  40m