You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "Jeff Hammerbacher (JIRA)" <ji...@apache.org> on 2010/01/13 20:06:54 UTC

[jira] Created: (AVRO-319) Replace Forrest for documentation generation

Replace Forrest for documentation generation
--------------------------------------------

                 Key: AVRO-319
                 URL: https://issues.apache.org/jira/browse/AVRO-319
             Project: Avro
          Issue Type: Improvement
          Components: build
            Reporter: Jeff Hammerbacher


Drop options in the comments and we can decide on a better system than Forrest

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (AVRO-319) Replace Forrest for documentation generation

Posted by "Patrick Hunt (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/AVRO-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12800377#action_12800377 ] 

Patrick Hunt commented on AVRO-319:
-----------------------------------

fwiw in zookeeper we've seen a few major complaints on forrest; 1) use of xml for markup, 2) the project seems very "cobbled up"
in the sense that there's all kinds of third party libs are used that make things very difficult to debug/fix when problems occur, and 3)
the fact that the project is not making progress (still requires java5 and no releases for > 2 yrs)

zookeeper has been considering sphinx and possibly webby  http://webby.rubyforge.org/ (python/ruby respectively)

both of these implementations allow simpler/focused markup forms

thoughts on xml vs "markup"? I believe sphinx uses reST while webby allows a number of diff input formats. sphinx/webby both allow 
html/pdf output. First I've heard of anakia, but it doesn't seem like a good option for us (zk) as it uses xml for input.


> Replace Forrest for documentation generation
> --------------------------------------------
>
>                 Key: AVRO-319
>                 URL: https://issues.apache.org/jira/browse/AVRO-319
>             Project: Avro
>          Issue Type: Improvement
>          Components: build
>            Reporter: Jeff Hammerbacher
>
> Drop options in the comments and we can decide on a better system than Forrest

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (AVRO-319) Replace Forrest for documentation generation

Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/AVRO-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12799883#action_12799883 ] 

Doug Cutting commented on AVRO-319:
-----------------------------------

There's a plugin for Forrest that generates Anakia files.  This was used by the Incubator to switch from Forrest to Anakia due to frustration with Forrest.

Anakia is another Apache, Java-based, XML-in, HTML-out system, except it's faster, easier to use, etc. than Forrest.  HTTPD and APR, no-nonsense C projects, no fans of Java, use Anakia for their websites: https://svn.apache.org/repos/asf/httpd/site/trunk/.


> Replace Forrest for documentation generation
> --------------------------------------------
>
>                 Key: AVRO-319
>                 URL: https://issues.apache.org/jira/browse/AVRO-319
>             Project: Avro
>          Issue Type: Improvement
>          Components: build
>            Reporter: Jeff Hammerbacher
>
> Drop options in the comments and we can decide on a better system than Forrest

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (AVRO-319) Replace Forrest for documentation generation

Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/AVRO-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12799874#action_12799874 ] 

Jeff Hammerbacher commented on AVRO-319:
----------------------------------------

Sphinx is popular in the Python community: http://sphinx.pocoo.org

> Replace Forrest for documentation generation
> --------------------------------------------
>
>                 Key: AVRO-319
>                 URL: https://issues.apache.org/jira/browse/AVRO-319
>             Project: Avro
>          Issue Type: Improvement
>          Components: build
>            Reporter: Jeff Hammerbacher
>
> Drop options in the comments and we can decide on a better system than Forrest

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.