You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by st...@apache.org on 2010/06/08 19:23:23 UTC

svn commit: r952740 - in /hbase/trunk: pom.xml src/site/fml/ src/site/fml/faq.fml src/site/site.xml src/site/xdoc/index.xml src/site/xdoc/old_news.xml

Author: stack
Date: Tue Jun  8 17:23:23 2010
New Revision: 952740

URL: http://svn.apache.org/viewvc?rev=952740&view=rev
Log:
HBASE-2558 Our' JAVADOC overview -- 'Getting Started', requirements, etc. -- is not carried across by mvn javadoc:javadoc target -- more clean of front-page, added faq, documentation section

Added:
    hbase/trunk/src/site/fml/
    hbase/trunk/src/site/fml/faq.fml
    hbase/trunk/src/site/xdoc/old_news.xml
Modified:
    hbase/trunk/pom.xml
    hbase/trunk/src/site/site.xml
    hbase/trunk/src/site/xdoc/index.xml

Modified: hbase/trunk/pom.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/pom.xml?rev=952740&r1=952739&r2=952740&view=diff
==============================================================================
--- hbase/trunk/pom.xml (original)
+++ hbase/trunk/pom.xml Tue Jun  8 17:23:23 2010
@@ -7,11 +7,13 @@
   <packaging>jar</packaging>
   <version>0.21.0-SNAPSHOT</version>
   <name>HBase</name>
+  <!-- START SNIPPET: description -->
   <description>
   HBase is the &amp;lt;a href="http://hadoop.apache.org"&amp;rt;Hadoop&lt;/a&amp;rt; database. Use it when you need random, realtime read/write access to your Big Data.
     This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters
     of commodity hardware.
   </description>
+  <!-- END SNIPPET: description -->
   <url>http://hbase.apache.org</url>
 
   <licenses>

Added: hbase/trunk/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/fml/faq.fml?rev=952740&view=auto
==============================================================================
--- hbase/trunk/src/site/fml/faq.fml (added)
+++ hbase/trunk/src/site/fml/faq.fml Tue Jun  8 17:23:23 2010
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2010 The Apache Software Foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<faqs id="faqs1">
+  <part id="part1">
+    <faq id="faq1">
+      <question>What is a good question?</question>
+      <answer>
+        <p>Any valid XHTML can be placed in the <code>answer</code> element</p>
+      </answer>
+    </faq>
+  </part>
+</faqs>

Modified: hbase/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/site.xml?rev=952740&r1=952739&r2=952740&view=diff
==============================================================================
--- hbase/trunk/src/site/site.xml (original)
+++ hbase/trunk/src/site/site.xml Tue Jun  8 17:23:23 2010
@@ -12,30 +12,29 @@
     <src>http://hbase.apache.org/images/asf_logo_wide.png</src>
     <href>http://www.apache.org/</href>
   </bannerRight>
-  <publishDate position="navigation-bottom" />
+  <version position="right" />
+  <publishDate position="right" />
   <body>
-    <links>
-      <item name="Wiki" href="http://wiki.apache.org/hadoop/Hbase" />
-      <item name="Hadoop" href="http://hadoop.apache.org/" />
-    </links>
-
     <menu name="HBase">
       <item name="Overview" href="index.html"/>
       <item name="License" href="license.html" />
       <item name="Downloads" href="http://www.apache.org/dyn/closer.cgi/hadoop/hbase/" />
       <item name="Release Notes" href="https://issues.apache.org/jira/browse/HBASE?report=com.atlassian.jira.plugin.system.project:changelog-panel" />
-      <item name="Getting Started" href="apidocs/index.html#started" />
-      <item name="API" href="apidocs/" />
-      <item name="X-Ref" href="xref/" />
       <item name="Issue Tracking" href="issue-tracking.html" />
       <item name="Mailing Lists" href="mail-lists.html" />
       <item name="Source Repository" href="source-repository.html" />
+      <item name="FAQ" href="faq.html" />
       <item name="Wiki" href="http://wiki.apache.org/hadoop/Hbase" />
+      <item name="Team" href="team-list.html" />
+    </menu>
+    <menu name="Documentation">
+      <item name="Getting Started" href="apidocs/index.html#started" />
+      <item name="API" href="apidocs/" />
+      <item name="X-Ref" href="xref/" />
       <item name="ACID Semantics" href="acid-semantics.html" />
       <item name="Bulk Loads" href="bulk-loads.html" />
       <item name="Metrics"      href="metrics.html" />
       <item name="HBase on Windows"      href="cygwin.html" />
-      <item name="Team" href="team-list.html" />
     </menu>
   </body>
     <skin>

Modified: hbase/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/xdoc/index.xml?rev=952740&r1=952739&r2=952740&view=diff
==============================================================================
--- hbase/trunk/src/site/xdoc/index.xml (original)
+++ hbase/trunk/src/site/xdoc/index.xml Tue Jun  8 17:23:23 2010
@@ -23,27 +23,35 @@
   
   <body>
     <section name="This is Apache HBase">
-    <p>HBase is the <a href="http://hadoop.apache.org">Hadoop</a> database. Use it when you need random, realtime read/write access to your Big Data.
-    This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters
-    of commodity hardware.
-    <img src="http://hbase.apache.org/images/hadoop-logo.jpg" align="right" style="border-style;none" />
-    </p>
-    </section>
-    <section name="News">
+    <p>
+    HBase is the <a href="http://hadoop.apache.org">Hadoop</a> database. Use it when you need random, realtime read/write access to your Big Data.
+    This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters of commodity hardware.
+<div style="float: right;">
+    <img src="http://hbase.apache.org/images/hadoop-logo.jpg" style="border-style;none" />
+</div>
+HBase is an open-source, distributed, versioned, column-oriented store modeled after Google' <a hef="http://labs.google.com/papers/bigtable.html">Bigtable: A Distributed Storage System for Structured</a> by Chang et al. Just as Bigtable leverages the distributed data storage provided by the Google File System, HBase provides Bigtable-like capabilities on top of Hadoop.
+HBase includes:
+<ul>
+    <li>Convenient base classes for backing Hadoop MapReduce jobs with HBase tables including cascading, hive and pig source and sink modules
+</li>
+    <li>Query predicate push down via server side scan and get filters
+</li>
+    <li>Optimizations for real time queries
+</li>
+    <li>A Thrift gateway and a REST-ful Web service that supports XML, Protobuf, and binary data encoding options
+</li>
+    <li>Extensible jruby-based (JIRB) shell
+</li>
+    <li>Support for exporting metrics via the Hadoop metrics subsystem to files or Ganglia; or via JMX
+</li>
+</ul>
+</p>
+
+        </section>
+        <section name="News">
       <p>June 30th, <a href="http://www.meetup.com/hbaseusergroup/calendar/13562846/">HBase Contributor Workshop</a> (Day after Hadoop Summit)</p>
       <p>May 10th, 2010: HBase graduates from Hadoop sub-project to Apache Top Level Project </p>
-      <p>Signup for <a href="http://www.meetup.com/hbaseusergroup/calendar/12689490/">HBase User Group Meeting, HUG10</a> hosted by Trend Micro, April 19th, 2010</p>
-
-      <p><a href="http://www.meetup.com/hbaseusergroup/calendar/12689351/">HBase User Group Meeting, HUG9</a> hosted by Mozilla, March 10th, 2010</p>
-      <p>Sign up for the <a href="http://www.meetup.com/hbaseusergroup/calendar/12241393/">HBase User Group Meeting, HUG8</a>, January 27th, 2010 at StumbleUpon in SF</p>
-      <p>September 8th, 2010: HBase 0.20.0 is faster, stronger, slimmer, and sweeter tasting than any previous HBase release.  Get it off the <a href="releases.html">Releases</a> page.</p>
-      <p><a href="http://dev.us.apachecon.com/c/acus2009/">ApacheCon</a> in Oakland: November 2-6th, 2009: 
-      The Apache Foundation will be celebrating its 10th anniversary in beautiful Oakland by the Bay. Lots of good talks and meetups including an HBase presentation by a couple of the lads.</p>
-      <p>HBase at Hadoop World in NYC: October 2nd, 2009: A few of us will be talking on Practical HBase out east at <a href="http://www.cloudera.com/hadoop-world-nyc">Hadoop World: NYC</a>.</p>
-      <p>HUG7 and HBase Hackathon: August 7th-9th, 2009 at StumbleUpon in SF: Sign up for the <a href="http://www.meetup.com/hbaseusergroup/calendar/10950511/">HBase User Group Meeting, HUG7</a> or for the <a href="http://www.meetup.com/hackathon/calendar/10951718/">Hackathon</a> or for both (all are welcome!).</p>
-      <p>June, 2009 -- HBase at HadoopSummit2009 and at NOSQL: See the <a href="http://wiki.apache.org/hadoop/HBase/HBasePresentations">presentations</a></p>
-      <p>March 3rd, 2009 -- HUG6: <a href="http://www.meetup.com/hbaseusergroup/calendar/9764004/">HBase User Group 6</a></p>
-      <p>January 30th, 2009 -- LA Hbackathon:<a href="http://www.meetup.com/hbasela/calendar/9450876/">HBase January Hackathon Los Angeles</a> at <a href="http://streamy.com" >Streamy</a> in Manhattan Beach</p>
+      <p><a href="old_news.html">...</a></p>
     </section>
   </body>
   

Added: hbase/trunk/src/site/xdoc/old_news.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/xdoc/old_news.xml?rev=952740&view=auto
==============================================================================
--- hbase/trunk/src/site/xdoc/old_news.xml (added)
+++ hbase/trunk/src/site/xdoc/old_news.xml Tue Jun  8 17:23:23 2010
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2010 The Apache Software Foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+          "http://forrest.apache.org/dtd/document-v20.dtd">
+
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+  <properties>
+    <title> 
+      Old News
+    </title>
+  </properties>
+  <body>
+  <section name="Old News">
+      <p>Signup for <a href="http://www.meetup.com/hbaseusergroup/calendar/12689490/">HBase User Group Meeting, HUG10</a> hosted by Trend Micro, April 19th, 2010</p>
+
+      <p><a href="http://www.meetup.com/hbaseusergroup/calendar/12689351/">HBase User Group Meeting, HUG9</a> hosted by Mozilla, March 10th, 2010</p>
+      <p>Sign up for the <a href="http://www.meetup.com/hbaseusergroup/calendar/12241393/">HBase User Group Meeting, HUG8</a>, January 27th, 2010 at StumbleUpon in SF</p>
+      <p>September 8th, 2010: HBase 0.20.0 is faster, stronger, slimmer, and sweeter tasting than any previous HBase release.  Get it off the <a href="releases.html">Releases</a> page.</p>
+      <p><a href="http://dev.us.apachecon.com/c/acus2009/">ApacheCon</a> in Oakland: November 2-6th, 2009: 
+      The Apache Foundation will be celebrating its 10th anniversary in beautiful Oakland by the Bay. Lots of good talks and meetups including an HBase presentation by a couple of the lads.</p>
+      <p>HBase at Hadoop World in NYC: October 2nd, 2009: A few of us will be talking on Practical HBase out east at <a href="http://www.cloudera.com/hadoop-world-nyc">Hadoop World: NYC</a>.</p>
+      <p>HUG7 and HBase Hackathon: August 7th-9th, 2009 at StumbleUpon in SF: Sign up for the <a href="http://www.meetup.com/hbaseusergroup/calendar/10950511/">HBase User Group Meeting, HUG7</a> or for the <a href="http://www.meetup.com/hackathon/calendar/10951718/">Hackathon</a> or for both (all are welcome!).</p>
+      <p>June, 2009 -- HBase at HadoopSummit2009 and at NOSQL: See the <a href="http://wiki.apache.org/hadoop/HBase/HBasePresentations">presentations</a></p>
+      <p>March 3rd, 2009 -- HUG6: <a href="http://www.meetup.com/hbaseusergroup/calendar/9764004/">HBase User Group 6</a></p>
+      <p>January 30th, 2009 -- LA Hbackathon:<a href="http://www.meetup.com/hbasela/calendar/9450876/">HBase January Hackathon Los Angeles</a> at <a href="http://streamy.com" >Streamy</a> in Manhattan Beach</p>
+  </section>
+  </body>
+</document>