FAQ
Publish generated HTML documentation for Thrift on the website
--------------------------------------------------------------

Key: HBASE-2153
URL: https://issues.apache.org/jira/browse/HBASE-2153
Project: Hadoop HBase
Issue Type: Improvement
Components: thrift
Reporter: Lars Francke
Assignee: Lars Francke
Priority: Minor


Thrift has a compiler that generates pretty HTML documentation for a .thrift file. An example can be seen on the Evernote page (http://www.evernote.com/about/developer/api/ref/). I think it'd be valuable to offer the same for HBase and publish it on the website alongside the normal documentation. I've never worked with Forrest before but I'll have a look if I can find the correct place to insert this.

There is one ticket on Thrift that I'd like to see resolved first (THRIFT-681).

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

Search Discussions

  • stack (JIRA) at Jan 21, 2010 at 7:37 pm
    [ https://issues.apache.org/jira/browse/HBASE-2153?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12803446#action_12803446 ]

    stack commented on HBASE-2153:
    ------------------------------

    This looks great Lars. You think we could bundle this inside the javadoc -- e.g. as http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html#unprocessed -- and link to it from the thrift package doc? This way its versioned and travels with the targetted hbase.
    Publish generated HTML documentation for Thrift on the website
    --------------------------------------------------------------

    Key: HBASE-2153
    URL: https://issues.apache.org/jira/browse/HBASE-2153
    Project: Hadoop HBase
    Issue Type: Improvement
    Components: thrift
    Reporter: Lars Francke
    Assignee: Lars Francke
    Priority: Minor

    Thrift has a compiler that generates pretty HTML documentation for a .thrift file. An example can be seen on the Evernote page (http://www.evernote.com/about/developer/api/ref/). I think it'd be valuable to offer the same for HBase and publish it on the website alongside the normal documentation. I've never worked with Forrest before but I'll have a look if I can find the correct place to insert this.
    There is one ticket on Thrift that I'd like to see resolved first (THRIFT-681).
    --
    This message is automatically generated by JIRA.
    -
    You can reply to this email to add a comment to the issue online.
  • Lars Francke (JIRA) at Jan 22, 2010 at 2:39 am
    [ https://issues.apache.org/jira/browse/HBASE-2153?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

    Lars Francke updated HBASE-2153:
    --------------------------------

    Attachment: HBase-2153.patch

    That was easier then I expected. I didn't know about the this feature of Javadoc. This patch conflicts with the one on HBASE-1373 as both change the package documentation but I'll gladly update one patch once the other has been applied. It is an easy fix either way.

    This patch adds three generated files to the doc-files directory in the thrift package. Those are generated by the Thrift HTML generator. This also changes Hbase.thrift to add additional whitespace to generate properly formatted HTML.
    Publish generated HTML documentation for Thrift on the website
    --------------------------------------------------------------

    Key: HBASE-2153
    URL: https://issues.apache.org/jira/browse/HBASE-2153
    Project: Hadoop HBase
    Issue Type: Improvement
    Components: thrift
    Reporter: Lars Francke
    Assignee: Lars Francke
    Priority: Minor
    Attachments: HBase-2153.patch


    Thrift has a compiler that generates pretty HTML documentation for a .thrift file. An example can be seen on the Evernote page (http://www.evernote.com/about/developer/api/ref/). I think it'd be valuable to offer the same for HBase and publish it on the website alongside the normal documentation. I've never worked with Forrest before but I'll have a look if I can find the correct place to insert this.
    There is one ticket on Thrift that I'd like to see resolved first (THRIFT-681).
    --
    This message is automatically generated by JIRA.
    -
    You can reply to this email to add a comment to the issue online.
  • stack (JIRA) at Jan 23, 2010 at 4:53 am
    [ https://issues.apache.org/jira/browse/HBASE-2153?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

    stack resolved HBASE-2153.
    --------------------------

    Resolution: Fixed
    Fix Version/s: 0.21.0
    Hadoop Flags: [Reviewed]

    Committed to TRUNK after adding a bit more text after the hbase.thrift link that hopefully will encourage people to click through to the fancy thrift doc of the thrift interface. Thanks for the contrib Lars. Nice one.
    Publish generated HTML documentation for Thrift on the website
    --------------------------------------------------------------

    Key: HBASE-2153
    URL: https://issues.apache.org/jira/browse/HBASE-2153
    Project: Hadoop HBase
    Issue Type: Improvement
    Components: thrift
    Reporter: Lars Francke
    Assignee: Lars Francke
    Priority: Minor
    Fix For: 0.21.0

    Attachments: HBase-2153.patch


    Thrift has a compiler that generates pretty HTML documentation for a .thrift file. An example can be seen on the Evernote page (http://www.evernote.com/about/developer/api/ref/). I think it'd be valuable to offer the same for HBase and publish it on the website alongside the normal documentation. I've never worked with Forrest before but I'll have a look if I can find the correct place to insert this.
    There is one ticket on Thrift that I'd like to see resolved first (THRIFT-681).
    --
    This message is automatically generated by JIRA.
    -
    You can reply to this email to add a comment to the issue online.

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
groupdev @
categorieshbase, hadoop
postedJan 21, '10 at 1:19p
activeJan 23, '10 at 4:53a
posts4
users1
websitehbase.apache.org

1 user in discussion

stack (JIRA): 4 posts

People

Translate

site design / logo © 2022 Grokbase