[
https://issues.apache.org/jira/browse/FLUME-1242?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13286283#comment-13286283
]
Will McQueen commented on FLUME-1242:
-------------------------------------
Thanks, Mike. I think the docs look beautiful now and... easily editable! The
RST format looks to be much more user-friendly, and I believe this will make it
easy for the community to help with contributions to the guides.
When building with 'mvn clean package', I noticed some warnings and errors in
the output related to sphyx (output shown below). The error about
'flume-logo.png' is probably why the flume logo isn't appearing in the top-left
corner of the guides.
writing additional files... genindex search
copying static files...
/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/FlumeDeveloperGuide.rst:None:
WARNING: image file not readable: images/DevGuide_image00.png
/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/FlumeDeveloperGuide.rst:None:
WARNING: image file not readable: images/DevGuide_image01.png
/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/FlumeUserGuide.rst:None:
WARNING: image file not readable: images/UserGuide_image00.png
/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/FlumeUserGuide.rst:None:
WARNING: image file not readable: images/UserGuide_image03.png
/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/FlumeUserGuide.rst:None:
WARNING: image file not readable: images/UserGuide_image02.png
/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/FlumeUserGuide.rst:None:
WARNING: image file not readable: images/UserGuide_image01.png
/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/FlumeDeveloperGuide.rst::
WARNING: document isn't included in any toctree
/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/FlumeUserGuide.rst::
WARNING: document isn't included in any toctree
Exception occurred:
File
"/home/will/.m2/repository/org/python/jython-standalone/2.5.2/jython-standalone-2.5.2.jar/Lib/shutil.py",
line 51, in copyfile
fsrc = open(src, 'rb')
IOError: [Errno 2] No such file or directory:
'/home/will/Desktop/sphynx/flume/flume-ng-doc/sphinx/images/flume-logo.png'
> Make flume user & dev guides easily editable
> --------------------------------------------
>
> Key: FLUME-1242
> URL: https://issues.apache.org/jira/browse/FLUME-1242
> Project: Flume
> Issue Type: Improvement
> Reporter: Mike Percy
> Assignee: Mike Percy
> Fix For: v1.2.0
>
>
> Make flume user & dev guides editable
--
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