hbase-issues mailing list archives

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

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

Wade Arnold commented on HBASE-2650:
------------------------------------

I would like to propose a manual to the repository that covers the majority of the getting
started, building, deploying articles that really need to keep up to and versioned with releases.
 This would be different than the general wiki were discussions can flow but would ultimately
be promoted to the manual. I would like to propose that we use docbook. It is something that
I am familiar with from other open source projects and have used it with publishing companies.


I would like to add a directory to the repository as follows: 

hbase/trunk/documentation/manual/en/

I have written some documentation for the zend framework and there system is based on docbook
and works pretty well. This is the type of page that I would like to build for HBase. 

http://framework.zend.com/manual/en/
http://framework.zend.com/manual/en/zend.amf.server.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.21.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.


Mime
View raw message