[FLUME-1122] Flume documentation layout should be refactored

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.2.0
• Assignee: Hari Shreedharan
• Reporter: Arvind Prabhakar
• Created: 15/Apr/12 08:41
• Updated: 24/Apr/12 23:31
• Resolved: 24/Apr/12 22:25

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.