avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jeff McCarrell (JIRA)" <j...@apache.org>
Subject [jira] Commented: (AVRO-319) Replace Forrest for documentation generation
Date Thu, 29 Jul 2010 06:33:19 GMT

    [ https://issues.apache.org/jira/browse/AVRO-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12893530#action_12893530
] 

Jeff McCarrell commented on AVRO-319:
-------------------------------------

proposal:

the goal is: to end the suffering of forrest
 - other possible documentation refactoring is not in scope
follow the existing model as much as possible:
 - only change what has to change; don't make additional work
 - existing language formatters do not change
 -- C++ : doxygen
 -- C : asciidoc
 -- java : javadoc
 - language doc generation steps are separate from the top level docs generation
desired style will resemble httpd.apache.org
 - use anakia to build the top level site
 - but only the top level site gets generated via anakia
PDF support is dropped as of 1.4
 - because anakia doesn't support it
older versions of the documentation get stored as is (post rendering) in svn?
  or live on the site?
  open issue
to build the top level site docs requires:
 - a modern jvm and ant installed
 - svn checkout trunk
 - cd xdocs && ant docs
 - source: xdocs; target: build/docs
 -- anakia/velocity jar(s) checked into svn

so that means these sets of files:

proteus-> find site/author/content/xdocs -type f | grep -v .svn
site/author/content/xdocs/credits.xml
site/author/content/xdocs/index.xml
site/author/content/xdocs/irc.xml
site/author/content/xdocs/issue_tracking.xml
site/author/content/xdocs/mailing_lists.xml
site/author/content/xdocs/releases.xml
site/author/content/xdocs/site.xml
site/author/content/xdocs/tabs.xml
site/author/content/xdocs/version_control.xml

proteus-> find trunk/doc -type f | grep -v .svn
trunk/doc/build.xml
trunk/doc/src/content/xdocs/idl.xml
trunk/doc/src/content/xdocs/index.xml
trunk/doc/src/content/xdocs/site.xml
trunk/doc/src/content/xdocs/spec.xml
trunk/doc/src/content/xdocs/tabs.xml
trunk/doc/src/resources/images/avro-logo.png
trunk/doc/src/resources/images/favicon.ico
trunk/doc/src/resources/images/hadoop-logo.jpg
trunk/doc/src/skinconf.xml

are changed, and pretty much nothing else is.


> 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
>            Priority: Blocker
>             Fix For: 1.4.0
>
>
> 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