You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hbase.apache.org by "Mark Vigeant (JIRA)" <ji...@apache.org> on 2009/11/23 22:49:39 UTC
[jira] Created: (HBASE-2006) Documentation of hbase-site.xml
parameters
Documentation of hbase-site.xml parameters
------------------------------------------
Key: HBASE-2006
URL: https://issues.apache.org/jira/browse/HBASE-2006
Project: Hadoop HBase
Issue Type: Improvement
Components: documentation
Affects Versions: 0.20.2
Reporter: Mark Vigeant
Priority: Minor
There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "Mark Vigeant (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mark Vigeant updated HBASE-2006:
--------------------------------
Attachment: configuration.xsl
Basic XSL stylesheet that turns hbase-default.xml into a semi-nice table
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: configuration.xsl, hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12782301#action_12782301 ]
stack commented on HBASE-2006:
------------------------------
Mark: Sorry, don't go down that path. Contribute in some other way. How the hbase/hadoop doc. is generated is a nightmare to figure. I wouldn't wish it on my enemy. A few of us here know how to do it. We'll take this on. You've done enough. Thanks.
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: configuration.xsl, hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12782105#action_12782105 ]
stack commented on HBASE-2006:
------------------------------
No. Its great Mark. If you want to do more, play with the docs ant target and add transform that will dump the product into the right place in build/docs. Otherwise, its great. Thanks.
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: configuration.xsl, hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "Mark Vigeant (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12782078#action_12782078 ]
Mark Vigeant commented on HBASE-2006:
-------------------------------------
Yeah that sounds good. I'll tamper with the stylesheet to make it prettier if you'd like.
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: configuration.xsl, hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "Mark Vigeant (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12782202#action_12782202 ]
Mark Vigeant commented on HBASE-2006:
-------------------------------------
Hmmm ok I've never done that before so I'll check out the tutorials when I can, thanks!
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: configuration.xsl, hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12781678#action_12781678 ]
stack commented on HBASE-2006:
------------------------------
Mark: Do you think it a good idea having the "documentation" in two places -- in the xml description tag and then elsewhere in the software or up on a wiki? In my experience, the two tend to diverge pretty soon after they are made.
That said, maybe we're missing documentation of the key configurations or better intro doc. that highlights important config? Thanks.
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "Mark Vigeant (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12782022#action_12782022 ]
Mark Vigeant commented on HBASE-2006:
-------------------------------------
I just added a very basic XSL sheet that works if you want to open up the xml document in firefox. Is this the kind of thing you had in mind?
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: configuration.xsl, hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12782052#action_12782052 ]
stack commented on HBASE-2006:
------------------------------
Thank you Mark. Should I change this issue to be about adding to the javadoc docs target the generation of a page using this stylesheet and adding it to the nav bar under metrics and windows doc here: http://hadoop.apache.org/hbase/docs/r0.20.2/? What you think?
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: configuration.xsl, hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12781989#action_12781989 ]
stack commented on HBASE-2006:
------------------------------
Thats a nice idea Lars; a stylesheet that made an xdocs or whatever out of an hbase-default.xml. J-D was saying recently how we should docbook it all.
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "Mark Vigeant (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mark Vigeant updated HBASE-2006:
--------------------------------
Attachment: hbase_parameters.doc
This is taken directly from the default config file, just put in a document format.
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "Mark Vigeant (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12781987#action_12781987 ]
Mark Vigeant commented on HBASE-2006:
-------------------------------------
You're absolutely right Stack, and it certainly doesn't make sense to have 2 diverging documentations that would only serve to make people more confused. I do believe though that the key configurations need to be more eloquently detailed.
I like your idea Lars, but I'm not sure how to do it since I haven't used XSLT before. It sounds like it could work though; from the looks of it all the w3 tutorial all it takes is a XSL stylesheet.
I think both ideas here are good and potentially very beneficial. I think that I could try to work on the XSLT transformation but it would require a much more involved committer to the project to create a more detailed summary of the key configurations (I'm thinking like how ZooKeeper is documented). Would that be too much of a hassle so early on, or should we wait until HBase 1.0.0?
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2006) Documentation of hbase-site.xml
parameters
Posted by "Lars George (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12781808#action_12781808 ]
Lars George commented on HBASE-2006:
------------------------------------
I am with Stack here, the external documents tend to get outdated soon. This would be probably different if we were on HBase 3.0.0 or so. Since we are not I always wondered if there is no way to use a XSLT transformation that takes the hbase-default.xml and converts it into a nicely tabled (as you suggest) JavaDoc page up in docs? So that the "ant docs" always creates a current copy and which is linked to the API docs. That way the Wiki could simply point to that page up in the repo and never be outdated. Would that work?
> Documentation of hbase-site.xml parameters
> ------------------------------------------
>
> Key: HBASE-2006
> URL: https://issues.apache.org/jira/browse/HBASE-2006
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.20.2
> Reporter: Mark Vigeant
> Priority: Minor
> Attachments: hbase_parameters.doc
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> There is nowhere on the site or wiki a detailed examination of the parameters behind HBase. You have to open hbase-default.xml to see them and their descriptions. A page on the wiki with descriptions would be nice
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.