avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Patrick Hunt (JIRA)" <j...@apache.org>
Subject [jira] Commented: (AVRO-319) Replace Forrest for documentation generation
Date Thu, 14 Jan 2010 21:53:54 GMT

    [ 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.


Mime
View raw message