You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hbase.apache.org by "stack (JIRA)" <ji...@apache.org> on 2008/10/22 23:45:44 UTC

[jira] Created: (HBASE-949) Add an HBase Manual

Add an HBase Manual
-------------------

                 Key: HBASE-949
                 URL: https://issues.apache.org/jira/browse/HBASE-949
             Project: Hadoop HBase
          Issue Type: Bug
            Reporter: stack
            Assignee: stack
            Priority: Blocker
             Fix For: 0.20.0


HBase needs a Manual.  Manual can be checked in under docs and evolve as hbase does (Hopefully we get to a state where new feature can't be closed unless manual has been updated to include mention and howto).  Let this issue be about adding under docs an outline with some basic getting started info.  Thereafter, we can open individual issues to add "chapters" or topics.

Made it a blocker on 0.20.0.

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


[jira] Resolved: (HBASE-949) Add an HBase Manual

Posted by "stack (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HBASE-949?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

stack resolved HBASE-949.
-------------------------

       Resolution: Fixed
    Fix Version/s:     (was: 0.20.0)
                   0.19.0

I made a start on this for 0.19.0.

I suggest that prescription should be:

+ For each new feature, add a page under  src/docs/src/documentation/content/xdocs/ and then add it to the documentation tab in site.xml.  This way we start to build up the manual of pieces as is done in hadoop.  To start the process, I added a page on the new metrics feature.
+ Metainfo, info about hbase that does not rot as hbase moves through its releases should be kept up in the wiki.

Given that documentation is evolutionary rather than big bang -- at least on our project -- I'm resolving this issue.  As long as we all chase each other and make sure we add documentation per new feature as it goes in, we should be ok.

> Add an HBase Manual
> -------------------
>
>                 Key: HBASE-949
>                 URL: https://issues.apache.org/jira/browse/HBASE-949
>             Project: Hadoop HBase
>          Issue Type: Bug
>            Reporter: stack
>            Assignee: stack
>            Priority: Blocker
>             Fix For: 0.19.0
>
>
> HBase needs a Manual.  Manual can be checked in under docs and evolve as hbase does (Hopefully we get to a state where new feature can't be closed unless manual has been updated to include mention and howto).  Let this issue be about adding under docs an outline with some basic getting started info.  Thereafter, we can open individual issues to add "chapters" or topics.
> Made it a blocker on 0.20.0.

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


[jira] Commented: (HBASE-949) Add an HBase Manual

Posted by "stack (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HBASE-949?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12643681#action_12643681 ] 

stack commented on HBASE-949:
-----------------------------

Add to build.xml handling of fact that forrest requires java 1.5 (though all rest of hadoop/hbase is 1.6).

> Add an HBase Manual
> -------------------
>
>                 Key: HBASE-949
>                 URL: https://issues.apache.org/jira/browse/HBASE-949
>             Project: Hadoop HBase
>          Issue Type: Bug
>            Reporter: stack
>            Assignee: stack
>            Priority: Blocker
>             Fix For: 0.19.0
>
>
> HBase needs a Manual.  Manual can be checked in under docs and evolve as hbase does (Hopefully we get to a state where new feature can't be closed unless manual has been updated to include mention and howto).  Let this issue be about adding under docs an outline with some basic getting started info.  Thereafter, we can open individual issues to add "chapters" or topics.
> Made it a blocker on 0.20.0.

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