Flume documentation layout should be refactored
-----------------------------------------------
Key: FLUME-1122
URL: https://issues.apache.org/jira/browse/FLUME-1122
Project: Flume
Issue Type: Improvement
Reporter: Arvind Prabhakar
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:
{noformat}
$ 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
$
{noformat}
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.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
