You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hbase.apache.org by "Kay Kay (JIRA)" <ji...@apache.org> on 2010/02/06 01:52:27 UTC
[jira] Created: (HBASE-2185) Add html version of default
hbase-site.xml
Add html version of default hbase-site.xml
-------------------------------------------
Key: HBASE-2185
URL: https://issues.apache.org/jira/browse/HBASE-2185
Project: Hadoop HBase
Issue Type: Improvement
Components: documentation
Reporter: Kay Kay
In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
patch creates a html file from the default hbase-default.xml usign xslt.
new target - conf.gen.html - added.
sample run
$ ant conf.gen.html
Buildfile: build.xml
init:
conf.gen.html:
[xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
[xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
[echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "Kay Kay (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12831226#action_12831226 ]
Kay Kay commented on HBASE-2185:
--------------------------------
{quote}
So only thing missing that I can see is adding a link to the newly made hbase-default.html somewhere.
{quote}
With the latest patch - it should be available in the top-level as a separate element ( See: site-xml part of the patch)
{quote}
It should be referenced from our 'getting started' or some place like that? As a link off the end of our overview? What you think Kay Kay?
{quote}
That would be ideal , I believe. The overview page would definitely be appropriate. For now- I did not know where to stick it in, so added as a site-map element that appears in the top-level.
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch, HBASE-2185.patch, HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "Kay Kay (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kay Kay updated HBASE-2185:
---------------------------
Attachment: HBASE-2185.patch
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "Kay Kay (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kay Kay updated HBASE-2185:
---------------------------
Status: Patch Available (was: Open)
ant 'docs' should do the trick now.
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch, HBASE-2185.patch, HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "Kay Kay (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kay Kay updated HBASE-2185:
---------------------------
Attachment: HBASE-2185.patch
integrated with 'docs' target.
New element - HBase Default configuration added to sitemap.
xslt applied on hbase-default.conf to generate a forrest-specific input file.
Running forrest on the same generates the hbase default configuration in html format.
* Also changed docs such that - it copies files from src/docs to build/docinput and then applies forrest on the same to avoid polluting src namespace ( forrest creates a build directory under src/docs as part of the process).
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch, HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "Kay Kay (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12831228#action_12831228 ]
Kay Kay commented on HBASE-2185:
--------------------------------
{quote}
newly made hbase-default.html somewhere
{quote}
Actually when creating the output - I had named the (generated) file as hbase-conf.html , that takes hbase-default.xml as input , though.
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch, HBASE-2185.patch, HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12830583#action_12830583 ]
stack commented on HBASE-2185:
------------------------------
This looks great Kay Kay. Should it be called from the docs target and the product linked too somewhere up in the doc? Perhaps from an article on default hbase settings? (xdoc -- like metrics article you'll see when you click on 'documentation'). Do we have an xslt engine in our classpath... ant finds one in the jvm?
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
stack updated HBASE-2185:
-------------------------
Resolution: Fixed
Fix Version/s: 0.21.0
0.20.4
Hadoop Flags: [Reviewed]
Status: Resolved (was: Patch Available)
Thanks Kay Kay. I renamed configuration.xsl as tohtml.xsl, added license and a note on what stylesheet does. Committed TRUNK and branch.
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Fix For: 0.20.4, 0.21.0
>
> Attachments: HBASE-2185.patch, HBASE-2185.patch, HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "Kay Kay (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12830587#action_12830587 ]
Kay Kay commented on HBASE-2185:
--------------------------------
| Should it be called from the docs target and the product linked too somewhere up in the doc?
That is ideal . I was playing around with forrest plugin and trying to make sure this integrates with the 'docs' target.
| Perhaps from an article on default hbase settings? (xdoc - like metrics article you'll see when you click on 'documentation').
If you were referring to this - http://hadoop.apache.org/hbase/docs/r0.20.3/metrics.html , then yes - it would be ideal to get this integrated with the docs target.
Similar to that - we can have a Hadoop Default Configuration as a subnode and use that. Ideally - we can have 'Getting Started' link as a separate html page by itself putting some introduction and then point to the package-info.java , as it does today.
| Do we have an xslt engine in our classpath... ant finds one in the jvm?
I do not have anything special loaded in my classpath. I guess the xslt target just uses the native xslt processor in the jvm and anybody with jdk 5+ (or , even jdk 1.4+) should be good. Since it is mandatory that we use java 6 - this should not be an issue.
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12831223#action_12831223 ]
stack commented on HBASE-2185:
------------------------------
So only thing missing that I can see is adding a link to the newly made hbase-default.html somewhere. It should be referenced from our 'getting started' or some place like that? As a link off the end of our overview? What you think Kay Kay?
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch, HBASE-2185.patch, HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-2185) Add html version of default
hbase-site.xml
Posted by "Kay Kay (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kay Kay updated HBASE-2185:
---------------------------
Attachment: HBASE-2185.patch
add cygwin.html to sitemap as before. this file does not seem to be present in the src control.
> Add html version of default hbase-site.xml
> -------------------------------------------
>
> Key: HBASE-2185
> URL: https://issues.apache.org/jira/browse/HBASE-2185
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Kay Kay
> Attachments: HBASE-2185.patch, HBASE-2185.patch, HBASE-2185.patch
>
>
> In the hadoop getting started page - there is a html version of the default configuration (of core-site.xml / hdfs-site.xml / mapred-site.xml ) .
> It would be useful to have such a page for hbase-default.xml for easy reference without flipping the editors.
> patch creates a html file from the default hbase-default.xml usign xslt.
> new target - conf.gen.html - added.
> sample run
> $ ant conf.gen.html
> Buildfile: build.xml
> init:
> conf.gen.html:
> [xslt] Processing /opt/workspace/remote-ws/hbase/conf/hbase-default.xml to /opt/workspace/remote-ws/hbase/build/hbase-site.html
> [xslt] Loading stylesheet /opt/workspace/remote-ws/hbase/docs/conf2html.xsl
> [echo] HTML Format of default HBase configuration available at /opt/workspace/remote-ws/hbase/build/hbase-site.html
> BUILD SUCCESSFUL
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.