hbase-issues mailing list archives

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

     [ https://issues.apache.org/jira/browse/HBASE-2650?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

stack updated HBASE-2650:

    Attachment: docbk.txt

Here is a patch that adds in mention of the above cited docbook plugin to our pom.  This plugin
is very nice, developed, well-documented, and under active development.  I see no reason why
we would ever do documentation in anything but docbook going forward (I tried to write something
in 'apt' yesterday and the doc for apt is so bad, in the end I had to resort to casting the
doc as xdoc, something that is supposed to be deprecated in mvn2 -- even though mvn2 tells
you that if you want to style your doc, use xdoc... not apt).  This plugin will process anything
put into src/docbkx directory.  You can do sweet stuff like pass pom attributes through to
the document so you can set an entity variable for things like hbase version, etc (See sample
book.xml page included in patch).  We can use xincludes to pull articles into the book.  It
seems to run pretty fast.  I think its because its downloaded all stylesheets local.

> 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
>         Attachments: docbk.txt
> 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