You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flume.apache.org by Mike Percy <mp...@gmail.com> on 2012/05/31 01:34:46 UTC

Review Request: FLUME-1242: Implement Flume User and Developer guides in ReStructuredTest, publish with maven-sphinx

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

Review request for Flume.


Summary
-------

Use Sphinx for ReStructuredText docs.
Ported index, user guide, and dev guide to RST. Removed xhtml & xdoc versions of the pages. Run sphinx using jython as part of the package phase.


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


Diffs
-----

  flume-ng-doc/resources/css/site.css 65aadf3 
  flume-ng-doc/resources/images/DevGuide_image00.png dd7eff0 
  flume-ng-doc/resources/images/DevGuide_image01.png ed77828 
  flume-ng-doc/resources/images/UserGuide_image00.png e587daf 
  flume-ng-doc/resources/images/UserGuide_image01.png ea97b2d 
  flume-ng-doc/resources/images/UserGuide_image02.png 85bdd95 
  flume-ng-doc/resources/images/UserGuide_image03.png b028b8b 
  flume-ng-doc/resources/images/flume-logo.jpeg f9ac5e2 
  flume-ng-doc/site.xml b2cf1df 
  flume-ng-doc/sphinx/FlumeDeveloperGuide.rst PRE-CREATION 
  flume-ng-doc/sphinx/FlumeUserGuide.rst PRE-CREATION 
  flume-ng-doc/sphinx/conf.py PRE-CREATION 
  flume-ng-doc/sphinx/css/site.css PRE-CREATION 
  flume-ng-doc/sphinx/images/DevGuide_image00.png PRE-CREATION 
  flume-ng-doc/sphinx/images/DevGuide_image01.png PRE-CREATION 
  flume-ng-doc/sphinx/images/UserGuide_image00.png PRE-CREATION 
  flume-ng-doc/sphinx/images/UserGuide_image01.png PRE-CREATION 
  flume-ng-doc/sphinx/images/UserGuide_image02.png PRE-CREATION 
  flume-ng-doc/sphinx/images/UserGuide_image03.png PRE-CREATION 
  flume-ng-doc/sphinx/images/flume-logo.png PRE-CREATION 
  flume-ng-doc/sphinx/index.rst PRE-CREATION 
  flume-ng-doc/xdoc/index.xml eef1b4f 
  flume-ng-doc/xhtml/FlumeDeveloperGuide.xhtml a7c74b3 
  flume-ng-doc/xhtml/FlumeUserGuide.xhtml 8a3de9f 
  pom.xml 216b4dd 

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


Testing
-------

Example output: https://people.apache.org/~mpercy/flume/flume-1.2.0-incubating-SNAPSHOT/docs/


Thanks,

Mike


Re: Review Request: FLUME-1242: Implement Flume User and Developer guides in ReStructuredTest, publish with maven-sphinx

Posted by Will McQueen <wi...@cloudera.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/5308/#review8281
-----------------------------------------------------------

Ship it!


lgtm! Thanks for fixing the warnings and the logo.

- Will


On 2012-05-31 08:06:24, Mike Percy wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/5308/
> -----------------------------------------------------------
> 
> (Updated 2012-05-31 08:06:24)
> 
> 
> Review request for Flume.
> 
> 
> Summary
> -------
> 
> Use Sphinx for ReStructuredText docs.
> Ported index, user guide, and dev guide to RST. Removed xhtml & xdoc versions of the pages. Run sphinx using jython as part of the package phase.
> 
> 
> This addresses bug FLUME-1242.
>     https://issues.apache.org/jira/browse/FLUME-1242
> 
> 
> Diffs
> -----
> 
>   flume-ng-doc/resources/css/site.css 65aadf3 
>   flume-ng-doc/resources/images/DevGuide_image00.png dd7eff0d5cc04b41d008a21637d21da7a74c8381 
>   flume-ng-doc/resources/images/DevGuide_image01.png ed77828d62d07c407d0e225f240266673db8e63e 
>   flume-ng-doc/resources/images/UserGuide_image00.png e587daf9e352dc23d62aca24214c5ae20c5055a3 
>   flume-ng-doc/resources/images/UserGuide_image01.png ea97b2d1953253e9f5454f51723e9a959e9781be 
>   flume-ng-doc/resources/images/UserGuide_image02.png 85bdd95239b870cc4016a5c79460897429342030 
>   flume-ng-doc/resources/images/UserGuide_image03.png b028b8b107b42e3492ad352ff9caf4d5eaf4105f 
>   flume-ng-doc/resources/images/flume-logo.jpeg f9ac5e2ec1a89d863710b0a1263190feb70e887d 
>   flume-ng-doc/site.xml b2cf1df 
>   flume-ng-doc/sphinx/FlumeDeveloperGuide.rst PRE-CREATION 
>   flume-ng-doc/sphinx/FlumeUserGuide.rst PRE-CREATION 
>   flume-ng-doc/sphinx/conf.py PRE-CREATION 
>   flume-ng-doc/sphinx/css/site.css PRE-CREATION 
>   flume-ng-doc/sphinx/images/DevGuide_image00.png PRE-CREATION 
>   flume-ng-doc/sphinx/images/DevGuide_image01.png PRE-CREATION 
>   flume-ng-doc/sphinx/images/UserGuide_image00.png PRE-CREATION 
>   flume-ng-doc/sphinx/images/UserGuide_image01.png PRE-CREATION 
>   flume-ng-doc/sphinx/images/UserGuide_image02.png PRE-CREATION 
>   flume-ng-doc/sphinx/images/UserGuide_image03.png PRE-CREATION 
>   flume-ng-doc/sphinx/images/flume-logo.png PRE-CREATION 
>   flume-ng-doc/sphinx/index.rst PRE-CREATION 
>   flume-ng-doc/xdoc/index.xml eef1b4f 
>   flume-ng-doc/xhtml/FlumeDeveloperGuide.xhtml a7c74b3 
>   flume-ng-doc/xhtml/FlumeUserGuide.xhtml 8a3de9f 
>   pom.xml 216b4dd 
> 
> Diff: https://reviews.apache.org/r/5308/diff
> 
> 
> Testing
> -------
> 
> Example output: https://people.apache.org/~mpercy/flume/flume-1.2.0-incubating-SNAPSHOT/docs/
> 
> 
> Thanks,
> 
> Mike
> 
>


Re: Review Request: FLUME-1242: Implement Flume User and Developer guides in ReStructuredTest, publish with maven-sphinx

Posted by Mike Percy <mp...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/5308/
-----------------------------------------------------------

(Updated 2012-05-31 08:06:24.363081)


Review request for Flume.


Changes
-------

Attaching binary diff, which properly includes the image renaming. Didn't realize I needed to do this diff via git diff --no-prefix --binary

Will probably not apply with regular patch, I guess you will need to do a git apply to get these changes.


Summary
-------

Use Sphinx for ReStructuredText docs.
Ported index, user guide, and dev guide to RST. Removed xhtml & xdoc versions of the pages. Run sphinx using jython as part of the package phase.


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


Diffs (updated)
-----

  flume-ng-doc/resources/css/site.css 65aadf3 
  flume-ng-doc/resources/images/DevGuide_image00.png dd7eff0d5cc04b41d008a21637d21da7a74c8381 
  flume-ng-doc/resources/images/DevGuide_image01.png ed77828d62d07c407d0e225f240266673db8e63e 
  flume-ng-doc/resources/images/UserGuide_image00.png e587daf9e352dc23d62aca24214c5ae20c5055a3 
  flume-ng-doc/resources/images/UserGuide_image01.png ea97b2d1953253e9f5454f51723e9a959e9781be 
  flume-ng-doc/resources/images/UserGuide_image02.png 85bdd95239b870cc4016a5c79460897429342030 
  flume-ng-doc/resources/images/UserGuide_image03.png b028b8b107b42e3492ad352ff9caf4d5eaf4105f 
  flume-ng-doc/resources/images/flume-logo.jpeg f9ac5e2ec1a89d863710b0a1263190feb70e887d 
  flume-ng-doc/site.xml b2cf1df 
  flume-ng-doc/sphinx/FlumeDeveloperGuide.rst PRE-CREATION 
  flume-ng-doc/sphinx/FlumeUserGuide.rst PRE-CREATION 
  flume-ng-doc/sphinx/conf.py PRE-CREATION 
  flume-ng-doc/sphinx/css/site.css PRE-CREATION 
  flume-ng-doc/sphinx/images/DevGuide_image00.png PRE-CREATION 
  flume-ng-doc/sphinx/images/DevGuide_image01.png PRE-CREATION 
  flume-ng-doc/sphinx/images/UserGuide_image00.png PRE-CREATION 
  flume-ng-doc/sphinx/images/UserGuide_image01.png PRE-CREATION 
  flume-ng-doc/sphinx/images/UserGuide_image02.png PRE-CREATION 
  flume-ng-doc/sphinx/images/UserGuide_image03.png PRE-CREATION 
  flume-ng-doc/sphinx/images/flume-logo.png PRE-CREATION 
  flume-ng-doc/sphinx/index.rst PRE-CREATION 
  flume-ng-doc/xdoc/index.xml eef1b4f 
  flume-ng-doc/xhtml/FlumeDeveloperGuide.xhtml a7c74b3 
  flume-ng-doc/xhtml/FlumeUserGuide.xhtml 8a3de9f 
  pom.xml 216b4dd 

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


Testing
-------

Example output: https://people.apache.org/~mpercy/flume/flume-1.2.0-incubating-SNAPSHOT/docs/


Thanks,

Mike