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 2008/02/12 00:56:00 UTC
svn commit: r620671 - in /hadoop/hbase: site/author/src/documentation/
site/author/src/documentation/content/xdocs/ site/publish/docs/ trunk/
trunk/docs/ trunk/src/docs/src/documentation/
trunk/src/docs/src/documentation/content/xdocs/
Author: stack
Date: Mon Feb 11 15:55:53 2008
New Revision: 620671
URL: http://svn.apache.org/viewvc?rev=620671&view=rev
Log:
hbase-436 website
Part 3: Edits and add current docs to website
Modified:
hadoop/hbase/site/author/src/documentation/content/xdocs/credits.xml
hadoop/hbase/site/author/src/documentation/content/xdocs/index.xml
hadoop/hbase/site/author/src/documentation/content/xdocs/mailing_lists.xml
hadoop/hbase/site/author/src/documentation/content/xdocs/site.xml
hadoop/hbase/site/author/src/documentation/skinconf.xml
hadoop/hbase/site/publish/docs/ (props changed)
hadoop/hbase/trunk/build.xml
hadoop/hbase/trunk/docs/index.html
hadoop/hbase/trunk/docs/linkmap.html
hadoop/hbase/trunk/src/docs/src/documentation/content/xdocs/tabs.xml
hadoop/hbase/trunk/src/docs/src/documentation/skinconf.xml
Modified: hadoop/hbase/site/author/src/documentation/content/xdocs/credits.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/site/author/src/documentation/content/xdocs/credits.xml?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/site/author/src/documentation/content/xdocs/credits.xml (original)
+++ hadoop/hbase/site/author/src/documentation/content/xdocs/credits.xml Mon Feb 11 15:55:53 2008
@@ -6,7 +6,7 @@
<document>
<header>
- <title>Hadoop Core credits</title>
+ <title>HBase credits</title>
</header>
<body>
@@ -60,6 +60,16 @@
<a href="https://issues.apache.org/jira/secure/ConfigureReport.jspa?versionId=-2&selectedProjectId=12310753&reportKey=com.sourcelabs.jira.plugin.report.contributions%3Acontributionreport&Next=Next">Jira</a>
</p>
+</section>
+
+<section>
+<title>Emeriti</title>
+
+<p>Contributors who are no longer active on HBase are:</p>
+
+<ul>
+ <li>Mike Cafarella</li>
+</ul>
</section>
</body>
Modified: hadoop/hbase/site/author/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/site/author/src/documentation/content/xdocs/index.xml?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/site/author/src/documentation/content/xdocs/index.xml (original)
+++ hadoop/hbase/site/author/src/documentation/content/xdocs/index.xml Mon Feb 11 15:55:53 2008
@@ -10,9 +10,33 @@
</header>
<body>
- <section>
- <title>TODO</title>
- </section>
+ <p>HBase is the Hadoop database. The original implementation was modelled on the paper, <a href="http://labs.google.com/papers/bigtable.html">Bigtable: A Distributed Storeage System for Structured Data</a> by Chang et al. Just as Bigtable leverages the distributed data storage provided by the <a href="http://labs.google.com/papers/gfs.html">Google File System</a>, HBase provides Bigtable-like capabilities on top of Hadoop.</p>
+
+ <p>For more information about HBase, please see the <a href="ext:wiki">Hadoop wiki.</a></p>
+
+ <section>
+ <title>Getting Started </title>
+ <p>
+ Start by installing hbase on a single machine or a very small cluster.
+ </p>
+ <ol>
+ <li><a href="ext:docs/current/index">Learn about</a> HBase by reading the documentation.</li>
+ <li><a href="releases.html">Download</a> Hadoop from the release page.</li>
+ <li><a href="mailing_lists.html">Discuss it</a> on the mailing list.</li>
+ </ol>
+ </section>
+
+ <section>
+ <title> Getting Involved </title>
+ <p>
+ HBase is an open source volunteer project under the Apache Software Foundation. We encourage you to learn about the project and contribute your expertise. Here are some starter links:
+ </p>
+ <ol>
+ <li>Give us <a href="issue_tracking.html">feedback</a>: What can we do better?</li>
+ <li>Join the <a href="mailing_lists.html">mailing list</a>: Meet the community.</li>
+ </ol>
+ </section>
+
</body>
</document>
Modified: hadoop/hbase/site/author/src/documentation/content/xdocs/mailing_lists.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/site/author/src/documentation/content/xdocs/mailing_lists.xml?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/site/author/src/documentation/content/xdocs/mailing_lists.xml (original)
+++ hadoop/hbase/site/author/src/documentation/content/xdocs/mailing_lists.xml Mon Feb 11 15:55:53 2008
@@ -14,7 +14,7 @@
<section>
<title>Users</title>
- <p>If you use Hadoop, please subscribe to the HBase user mailing list.</p>
+ <p>If you use HBase, please subscribe to the HBase user mailing list.</p>
<p>
The HBase user mailing list is :
@@ -49,9 +49,9 @@
<section>
<title>Commits</title>
- <p>If you'd like to see changes made in Hadoop's <a
+ <p>If you'd like to see changes made in HBase's <a
href="version_control.html">version control system</a>
- then subscribe to the Hadoop commit mailing list.</p>
+ then subscribe to the HBase commit mailing list.</p>
<ul>
<li><a href="mailto:hbase-commits-subscribe@hadoop.apache.org">Subscribe to List</a></li>
Modified: hadoop/hbase/site/author/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/site/author/src/documentation/content/xdocs/site.xml?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/site/author/src/documentation/content/xdocs/site.xml (original)
+++ hadoop/hbase/site/author/src/documentation/content/xdocs/site.xml Mon Feb 11 15:55:53 2008
@@ -25,7 +25,6 @@
<docs label="Documentation">
<current label="Current" href="ext:docs/current/"/>
- <r0.1.0 label="Release 0.1.0" href="ext:docs/r0.1.0/"/>
</docs>
<resources label="Developers">
Modified: hadoop/hbase/site/author/src/documentation/skinconf.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/site/author/src/documentation/skinconf.xml?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/site/author/src/documentation/skinconf.xml (original)
+++ hadoop/hbase/site/author/src/documentation/skinconf.xml Mon Feb 11 15:55:53 2008
@@ -65,7 +65,7 @@
<!-- project logo -->
<project-name>HBase</project-name>
- <project-description>A distributed storage system for structured data built on top of Hadoop</project-description>
+ <project-description>The Hadoop database</project-description>
<project-url>http://hadoop.apache.org/hbase/</project-url>
<project-logo>images/hbase_logo_med.gif</project-logo>
Propchange: hadoop/hbase/site/publish/docs/
------------------------------------------------------------------------------
--- svn:externals (added)
+++ svn:externals Mon Feb 11 15:55:53 2008
@@ -0,0 +1 @@
+current http://svn.apache.org/repos/asf/hadoop/hbase/trunk/docs
Modified: hadoop/hbase/trunk/build.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/build.xml?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/trunk/build.xml (original)
+++ hadoop/hbase/trunk/build.xml Mon Feb 11 15:55:53 2008
@@ -36,6 +36,7 @@
<property name="lib.dir" value="${basedir}/lib"/>
<property name="conf.dir" value="${basedir}/conf"/>
<property name="docs.dir" value="${basedir}/docs"/>
+ <property name="docs.src" value="${basedir}/src/docs"/>
<property name="test.output" value="no"/>
<property name="test.timeout" value="600000"/>
@@ -186,13 +187,11 @@
<chmod perm="ugo+x" type="file">
<fileset dir="${dist.dir}/bin" />
</chmod>
- <!--Uncomment when we have a docs dir
<mkdir dir="${dist.dir}/docs" />
<copy todir="${dist.dir}/docs">
<fileset dir="${docs.dir}" />
<fileset dir="${build.docs}"/>
</copy>
- -->
<copy todir="${dist.dir}">
<fileset dir=".">
<include name="*.txt" />
@@ -248,8 +247,22 @@
</target>
<!-- ================================================================== -->
- <!-- Javadoc -->
+ <!-- Doc -->
<!-- ================================================================== -->
+ <target name="docs" depends="forrest.check" description="Generate forrest-based documentation. To use, specify -Dforrest.home=<base of Apache Forrest installation> on the command line." if="forrest.home">
+ <exec dir="${docs.src}" executable="${forrest.home}/bin/forrest" failonerror="true" />
+ <copy todir="${docs.dir}">
+ <fileset dir="${docs.src}/build/site/" />
+ </copy>
+ <style basedir="${conf.dir}" destdir="${docs.dir}"
+ includes="hadoop-default.xml" style="conf/configuration.xsl"/>
+ </target>
+
+ <target name="forrest.check" unless="forrest.home">
+ <fail message="'forrest.home' is not defined. Please pass -Dforrest.home=<base of Apache Forrest installation> to Ant on the command-line." />
+ </target>
+
+ <!-- Javadoc -->
<target name="javadoc" description="Generate javadoc">
<mkdir dir="${build.javadoc}"/>
<javadoc
Modified: hadoop/hbase/trunk/docs/index.html
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/docs/index.html?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/trunk/docs/index.html (original)
+++ hadoop/hbase/trunk/docs/index.html Mon Feb 11 15:55:53 2008
@@ -39,7 +39,7 @@
|start Project Logo
+-->
<div class="projectlogo">
-<a href="http://hadoop.apache.org/hbase/"><img class="logoImage" alt="HBase" src="images/hbase_logo_med.gif" title="A distributed storage system for structured data built on top of Hadoop"></a>
+<a href="http://hadoop.apache.org/hbase/"><img class="logoImage" alt="HBase" src="images/hbase_logo_med.gif" title="The Hadoop database"></a>
</div>
<!--+
|end Project Logo
@@ -67,7 +67,7 @@
<a class="unselected" href="http://wiki.apache.org/hadoop/Hbase">Wiki</a>
</li>
<li class="current">
-<a class="selected" href="index.html">HBase 0.1 Documentation</a>
+<a class="selected" href="index.html">HBase Documentation</a>
</li>
</ul>
<!--+
Modified: hadoop/hbase/trunk/docs/linkmap.html
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/docs/linkmap.html?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/trunk/docs/linkmap.html (original)
+++ hadoop/hbase/trunk/docs/linkmap.html Mon Feb 11 15:55:53 2008
@@ -39,7 +39,7 @@
|start Project Logo
+-->
<div class="projectlogo">
-<a href="http://hadoop.apache.org/hbase/"><img class="logoImage" alt="HBase" src="images/hbase_logo_med.gif" title="A distributed storage system for structured data built on top of Hadoop"></a>
+<a href="http://hadoop.apache.org/hbase/"><img class="logoImage" alt="HBase" src="images/hbase_logo_med.gif" title="The Hadoop database"></a>
</div>
<!--+
|end Project Logo
@@ -67,7 +67,7 @@
<a class="unselected" href="http://wiki.apache.org/hadoop/Hbase">Wiki</a>
</li>
<li class="current">
-<a class="selected" href="index.html">HBase 0.1 Documentation</a>
+<a class="selected" href="index.html">HBase Documentation</a>
</li>
</ul>
<!--+
Modified: hadoop/hbase/trunk/src/docs/src/documentation/content/xdocs/tabs.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/docs/src/documentation/content/xdocs/tabs.xml?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/docs/src/documentation/content/xdocs/tabs.xml (original)
+++ hadoop/hbase/trunk/src/docs/src/documentation/content/xdocs/tabs.xml Mon Feb 11 15:55:53 2008
@@ -31,6 +31,6 @@
<tab label="Project" href="http://hadoop.apache.org/hbase/" />
<tab label="Wiki" href="http://wiki.apache.org/hadoop/Hbase" />
- <tab label="HBase 0.1 Documentation" dir="" />
+ <tab label="HBase Documentation" dir="" />
</tabs>
Modified: hadoop/hbase/trunk/src/docs/src/documentation/skinconf.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/docs/src/documentation/skinconf.xml?rev=620671&r1=620670&r2=620671&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/docs/src/documentation/skinconf.xml (original)
+++ hadoop/hbase/trunk/src/docs/src/documentation/skinconf.xml Mon Feb 11 15:55:53 2008
@@ -30,7 +30,7 @@
In other words google will search the @domain for the query string.
-->
- <search name="Lucene" domain="hadoop.apache.org" provider="google"/>
+ <search name="HBase" domain="hadoop.apache.org" provider="google"/>
<!-- Disable the print link? If enabled, invalid HTML 4.0.1 -->
<disable-print-link>true</disable-print-link>
@@ -65,7 +65,7 @@
<!-- project logo -->
<project-name>HBase</project-name>
- <project-description>A distributed storage system for structured data built on top of Hadoop</project-description>
+ <project-description>The Hadoop database</project-description>
<project-url>http://hadoop.apache.org/hbase/</project-url>
<project-logo>images/hbase_logo_med.gif</project-logo>