hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "stack (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HBASE-2650) Consolidate user guide style documentation
Date Tue, 13 Jul 2010 22:16:49 GMT

    [ https://issues.apache.org/jira/browse/HBASE-2650?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12888048#action_12888048

stack commented on HBASE-2650:

Proposal sounds good by me.

I'm of the docbook persuasion myself (Did the heritrix mvn build generated manuals from src
 -- see http://crawler.archive.org/articles/developer_manual/index.html).

How'd you get docbook to show like that in the zend website?  Its in a frame?

I'm not sure documentation/manual/en is right location in maven.  Might want to put it under
src/site into a docbook directory or so?  We can figure it out (I like the en subdir... jp,
cn, fr would be super cool)

This is the nifty maven: http://code.google.com/p/docbkx-tools/ (and its alive).

We should look at the doxia convertion tool.  We might be able to run it as part of the site
build to generate docbook articles from apt articles for inclusion in an hbase 'book'.  Here's
the convertion tool: http://maven.apache.org/doxia/doxia-tools/doxia-converter/usage.html

> Consolidate user guide style documentation
> ------------------------------------------
>                 Key: HBASE-2650
>                 URL: https://issues.apache.org/jira/browse/HBASE-2650
>             Project: HBase
>          Issue Type: Task
>          Components: documentation
>            Reporter: Todd Lipcon
>             Fix For: 0.90.0
> It would be great to clean up our documentation prior to the next major release. We have
various bits of docs strewn throughout the JavaDoc, but it's a lot of "hidden gems" (eg the
mapreduce package docs) whereas a separate "programmers guide" would be a lot better.

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

View raw message