Flume
  1. Flume
  2. FLUME-1122

Flume documentation layout should be refactored

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: v1.2.0
    • Component/s: None
    • Labels:
      None

      Description

      Currently a full build of Flume generates documentation in the top-level flume-docs directory. This causes a lot of flume-docs directories to show up as untracked files in the version control after build:

      $ svn stat
      ?       flume-docs
      ?       flume-ng-sdk/flume-docs
      ?       flume-ng-node/flume-docs
      ?       flume-ng-legacy-sources/flume-docs
      ?       flume-ng-legacy-sources/flume-thrift-source/flume-docs
      ?       flume-ng-legacy-sources/flume-avro-source/flume-docs
      ?       flume-ng-sinks/flume-docs
      ?       flume-ng-sinks/flume-irc-sink/flume-docs
      ?       flume-ng-sinks/flume-hdfs-sink/flume-docs
      ?       flume-ng-core/flume-docs
      ?       flume-ng-channels/flume-docs
      ?       flume-ng-channels/flume-file-channel/flume-docs
      ?       flume-ng-channels/flume-recoverable-memory-channel/flume-docs
      ?       flume-ng-channels/flume-jdbc-channel/flume-docs
      ?       flume-ng-clients/flume-docs
      ?       flume-ng-clients/flume-ng-log4jappender/flume-docs
      ?       flume-ng-dist/flume-docs
      $
      

      It would be better if the documentation was generated within the target direcatory (target/docs), and promoted to the top-level during the build of flume-ng-dist module. That way only the generated distribution will contain docs at the top level and not the rest of the workspace.

      1. FLUME-1122.patch
        1 kB
        Hari Shreedharan
      2. FLUME-1122-1.patch
        1 kB
        Hari Shreedharan

        Activity

        Arvind Prabhakar created issue -
        Mike Percy made changes -
        Field Original Value New Value
        Assignee Mike Percy [ mpercy ]
        Hari Shreedharan made changes -
        Assignee Mike Percy [ mpercy ] Hari Shreedharan [ hshreedharan ]
        Hari Shreedharan made changes -
        Attachment FLUME-1122.patch [ 12524063 ]
        Hari Shreedharan made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Hide
        jiraposter@reviews.apache.org added a comment -

        -----------------------------------------------------------
        This is an automatically generated e-mail. To reply, visit:
        https://reviews.apache.org/r/4859/
        -----------------------------------------------------------

        Review request for Flume and Arvind Prabhakar.

        Summary
        -------

        Flume docs now staged under target/flume-docs. Dist build moves it to top level.

        This addresses bug FLUME-1122.
        https://issues.apache.org/jira/browse/FLUME-1122

        Diffs


        flume-ng-dist/src/main/assembly/dist.xml 6a84922
        pom.xml 281f8b8

        Diff: https://reviews.apache.org/r/4859/diff

        Testing
        -------

        Ran a full build. No top level flume-docs directory created. Flume-docs directory created under target. Also, untar the dist tarball, top level flume-docs directory found with same content as top level target/flume-docs.

        Thanks,

        Hari

        Show
        jiraposter@reviews.apache.org added a comment - ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/4859/ ----------------------------------------------------------- Review request for Flume and Arvind Prabhakar. Summary ------- Flume docs now staged under target/flume-docs. Dist build moves it to top level. This addresses bug FLUME-1122 . https://issues.apache.org/jira/browse/FLUME-1122 Diffs flume-ng-dist/src/main/assembly/dist.xml 6a84922 pom.xml 281f8b8 Diff: https://reviews.apache.org/r/4859/diff Testing ------- Ran a full build. No top level flume-docs directory created. Flume-docs directory created under target. Also, untar the dist tarball, top level flume-docs directory found with same content as top level target/flume-docs. Thanks, Hari
        Hide
        jiraposter@reviews.apache.org added a comment -

        -----------------------------------------------------------
        This is an automatically generated e-mail. To reply, visit:
        https://reviews.apache.org/r/4859/#review7192
        -----------------------------------------------------------

        flume-ng-dist/src/main/assembly/dist.xml
        <https://reviews.apache.org/r/4859/#comment15890>

        Suggest calling it just docs

        pom.xml
        <https://reviews.apache.org/r/4859/#comment15892>

        Suggest you change it to just docs unless that causes some other problems.

        • Arvind

        On 2012-04-24 20:47:09, Hari Shreedharan wrote:

        -----------------------------------------------------------

        This is an automatically generated e-mail. To reply, visit:

        https://reviews.apache.org/r/4859/

        -----------------------------------------------------------

        (Updated 2012-04-24 20:47:09)

        Review request for Flume and Arvind Prabhakar.

        Summary

        -------

        Flume docs now staged under target/flume-docs. Dist build moves it to top level.

        This addresses bug FLUME-1122.

        https://issues.apache.org/jira/browse/FLUME-1122

        Diffs

        -----

        flume-ng-dist/src/main/assembly/dist.xml 6a84922

        pom.xml 281f8b8

        Diff: https://reviews.apache.org/r/4859/diff

        Testing

        -------

        Ran a full build. No top level flume-docs directory created. Flume-docs directory created under target. Also, untar the dist tarball, top level flume-docs directory found with same content as top level target/flume-docs.

        Thanks,

        Hari

        Show
        jiraposter@reviews.apache.org added a comment - ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/4859/#review7192 ----------------------------------------------------------- flume-ng-dist/src/main/assembly/dist.xml < https://reviews.apache.org/r/4859/#comment15890 > Suggest calling it just docs pom.xml < https://reviews.apache.org/r/4859/#comment15892 > Suggest you change it to just docs unless that causes some other problems. Arvind On 2012-04-24 20:47:09, Hari Shreedharan wrote: ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/4859/ ----------------------------------------------------------- (Updated 2012-04-24 20:47:09) Review request for Flume and Arvind Prabhakar. Summary ------- Flume docs now staged under target/flume-docs. Dist build moves it to top level. This addresses bug FLUME-1122 . https://issues.apache.org/jira/browse/FLUME-1122 Diffs ----- flume-ng-dist/src/main/assembly/dist.xml 6a84922 pom.xml 281f8b8 Diff: https://reviews.apache.org/r/4859/diff Testing ------- Ran a full build. No top level flume-docs directory created. Flume-docs directory created under target. Also, untar the dist tarball, top level flume-docs directory found with same content as top level target/flume-docs. Thanks, Hari
        Hide
        jiraposter@reviews.apache.org added a comment -

        -----------------------------------------------------------
        This is an automatically generated e-mail. To reply, visit:
        https://reviews.apache.org/r/4859/
        -----------------------------------------------------------

        (Updated 2012-04-24 22:15:51.105297)

        Review request for Flume and Arvind Prabhakar.

        Changes
        -------

        Incorporating Arvind's feedback.

        Summary
        -------

        Flume docs now staged under target/flume-docs. Dist build moves it to top level.

        This addresses bug FLUME-1122.
        https://issues.apache.org/jira/browse/FLUME-1122

        Diffs (updated)


        flume-ng-dist/src/main/assembly/dist.xml 6a84922
        pom.xml 281f8b8

        Diff: https://reviews.apache.org/r/4859/diff

        Testing
        -------

        Ran a full build. No top level flume-docs directory created. Flume-docs directory created under target. Also, untar the dist tarball, top level flume-docs directory found with same content as top level target/flume-docs.

        Thanks,

        Hari

        Show
        jiraposter@reviews.apache.org added a comment - ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/4859/ ----------------------------------------------------------- (Updated 2012-04-24 22:15:51.105297) Review request for Flume and Arvind Prabhakar. Changes ------- Incorporating Arvind's feedback. Summary ------- Flume docs now staged under target/flume-docs. Dist build moves it to top level. This addresses bug FLUME-1122 . https://issues.apache.org/jira/browse/FLUME-1122 Diffs (updated) flume-ng-dist/src/main/assembly/dist.xml 6a84922 pom.xml 281f8b8 Diff: https://reviews.apache.org/r/4859/diff Testing ------- Ran a full build. No top level flume-docs directory created. Flume-docs directory created under target. Also, untar the dist tarball, top level flume-docs directory found with same content as top level target/flume-docs. Thanks, Hari
        Hari Shreedharan made changes -
        Attachment FLUME-1122-1.patch [ 12524071 ]
        Hide
        jiraposter@reviews.apache.org added a comment -

        -----------------------------------------------------------
        This is an automatically generated e-mail. To reply, visit:
        https://reviews.apache.org/r/4859/#review7193
        -----------------------------------------------------------

        Ship it!

        +1

        • Arvind

        On 2012-04-24 22:15:51, Hari Shreedharan wrote:

        -----------------------------------------------------------

        This is an automatically generated e-mail. To reply, visit:

        https://reviews.apache.org/r/4859/

        -----------------------------------------------------------

        (Updated 2012-04-24 22:15:51)

        Review request for Flume and Arvind Prabhakar.

        Summary

        -------

        Flume docs now staged under target/flume-docs. Dist build moves it to top level.

        This addresses bug FLUME-1122.

        https://issues.apache.org/jira/browse/FLUME-1122

        Diffs

        -----

        flume-ng-dist/src/main/assembly/dist.xml 6a84922

        pom.xml 281f8b8

        Diff: https://reviews.apache.org/r/4859/diff

        Testing

        -------

        Ran a full build. No top level flume-docs directory created. Flume-docs directory created under target. Also, untar the dist tarball, top level flume-docs directory found with same content as top level target/flume-docs.

        Thanks,

        Hari

        Show
        jiraposter@reviews.apache.org added a comment - ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/4859/#review7193 ----------------------------------------------------------- Ship it! +1 Arvind On 2012-04-24 22:15:51, Hari Shreedharan wrote: ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/4859/ ----------------------------------------------------------- (Updated 2012-04-24 22:15:51) Review request for Flume and Arvind Prabhakar. Summary ------- Flume docs now staged under target/flume-docs. Dist build moves it to top level. This addresses bug FLUME-1122 . https://issues.apache.org/jira/browse/FLUME-1122 Diffs ----- flume-ng-dist/src/main/assembly/dist.xml 6a84922 pom.xml 281f8b8 Diff: https://reviews.apache.org/r/4859/diff Testing ------- Ran a full build. No top level flume-docs directory created. Flume-docs directory created under target. Also, untar the dist tarball, top level flume-docs directory found with same content as top level target/flume-docs. Thanks, Hari
        Hide
        Arvind Prabhakar added a comment -

        Patch committed. Thanks Hari!

        Show
        Arvind Prabhakar added a comment - Patch committed. Thanks Hari!
        Arvind Prabhakar made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Fix Version/s v1.2.0 [ 12320243 ]
        Resolution Fixed [ 1 ]
        Hide
        Hudson added a comment -

        Integrated in flume-trunk #183 (See https://builds.apache.org/job/flume-trunk/183/)
        FLUME-1122. Flume documentation layout refactoring.

        (Hari Shreedharan via Arvind Prabhakar) (Revision 1330048)

        Result = SUCCESS
        arvind : http://svn.apache.org/viewvc/?view=rev&rev=1330048
        Files :

        • /incubator/flume/trunk/flume-ng-dist/src/main/assembly/dist.xml
        • /incubator/flume/trunk/pom.xml
        Show
        Hudson added a comment - Integrated in flume-trunk #183 (See https://builds.apache.org/job/flume-trunk/183/ ) FLUME-1122 . Flume documentation layout refactoring. (Hari Shreedharan via Arvind Prabhakar) (Revision 1330048) Result = SUCCESS arvind : http://svn.apache.org/viewvc/?view=rev&rev=1330048 Files : /incubator/flume/trunk/flume-ng-dist/src/main/assembly/dist.xml /incubator/flume/trunk/pom.xml

          People

          • Assignee:
            Hari Shreedharan
            Reporter:
            Arvind Prabhakar
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development