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.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user ctubbsii closed the pull request at:

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

          Show
          githubbot ASF GitHub Bot added a comment - Github user ctubbsii closed the pull request at: https://github.com/apache/accumulo/pull/78
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user keith-turner commented on the pull request:

          https://github.com/apache/accumulo/pull/78#issuecomment-190879772

          +42 this is awesome.

          Show
          githubbot ASF GitHub Bot added a comment - Github user keith-turner commented on the pull request: https://github.com/apache/accumulo/pull/78#issuecomment-190879772 +42 this is awesome.
          Hide
          ctubbsii Christopher Tubbs added a comment -

          One issue: we also have org/apache/accumulo/core/data/doc-files/mutation-serialization.html, and I don't know how to get that to pass through. However, it really shouldn't be here. Instead, it should be moved to one of:

          1. package-info.java file,
          2. the Mutation class, or
          3. the user manual

          But, I'm not sure which option is best.

          Show
          ctubbsii Christopher Tubbs added a comment - One issue: we also have org/apache/accumulo/core/data/doc-files/mutation-serialization.html , and I don't know how to get that to pass through. However, it really shouldn't be here. Instead, it should be moved to one of: package-info.java file, the Mutation class, or the user manual But, I'm not sure which option is best.
          Show
          githubbot ASF GitHub Bot added a comment - Github user ctubbsii commented on the pull request: https://github.com/apache/accumulo/pull/78#issuecomment-189788354 https://issues.apache.org/jira/browse/ACCUMULO-4155
          Hide
          githubbot ASF GitHub Bot added a comment -

          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


          Show
          githubbot ASF GitHub Bot added a comment - 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

            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

                  Development