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/07/25 23:34:46 UTC
svn commit: r979124 - in /hbase/trunk: pom.xml src/docbkx/
src/docbkx/book.xml src/docbkx/sample_article.xml src/site/site.xml
Author: stack
Date: Sun Jul 25 21:34:46 2010
New Revision: 979124
URL: http://svn.apache.org/viewvc?rev=979124&view=rev
Log:
HBASE-2650 Consolidate user guide style documentation -- experiment with docbkx mvn plugin
Added:
hbase/trunk/src/docbkx/
hbase/trunk/src/docbkx/book.xml
hbase/trunk/src/docbkx/sample_article.xml
Modified:
hbase/trunk/pom.xml
hbase/trunk/src/site/site.xml
Modified: hbase/trunk/pom.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/pom.xml?rev=979124&r1=979123&r2=979124&view=diff
==============================================================================
--- hbase/trunk/pom.xml (original)
+++ hbase/trunk/pom.xml Sun Jul 25 21:34:46 2010
@@ -288,6 +288,37 @@
<plugins>
<plugin>
+ <groupId>com.agilejava.docbkx</groupId>
+ <artifactId>docbkx-maven-plugin</artifactId>
+ <version>2.0.10</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>generate-html</goal>
+ </goals>
+ <phase>pre-site</phase>
+ </execution>
+ </executions>
+ <dependencies>
+ <dependency>
+ <groupId>org.docbook</groupId>
+ <artifactId>docbook-xml</artifactId>
+ <version>4.4</version>
+ <scope>runtime</scope>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <xincludeSupported>true</xincludeSupported>
+ <chunkedOutput>true</chunkedOutput>
+ <useIdAsFilename>true</useIdAsFilename>
+ <targetDirectory>
+
+ ${basedir}/target/site/
+
+ </targetDirectory>
+ </configuration>
+ </plugin>
+ <plugin>
<artifactId>maven-assembly-plugin</artifactId>
<!-- THIS might not be doable
<executions>
Added: hbase/trunk/src/docbkx/book.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/docbkx/book.xml?rev=979124&view=auto
==============================================================================
--- hbase/trunk/src/docbkx/book.xml (added)
+++ hbase/trunk/src/docbkx/book.xml Sun Jul 25 21:34:46 2010
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<book version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <info>
+ <title>HBase Book
+<?eval ${project.version}?>
+
+ </title>
+ </info>
+
+ <chapter xml:id="getting_started">
+ <title >Getting Started</title>
+
+ <section>
+ <title>Requirements</title>
+
+ <para>First...</para>
+ </section>
+ </chapter>
+
+ <chapter xml:id="datamodel">
+ <title>Data Model</title>
+
+ <para></para>
+ </chapter>
+
+ <chapter xml:id="implementation">
+ <title>Implementation</title>
+
+ <para></para>
+ </chapter>
+
+ <chapter xml:id="mapreduce">
+ <title>MapReduce</title>
+
+ <para></para>
+ </chapter>
+
+ <chapter xml:id="schema">
+ <title>Schema Design</title>
+
+ <para></para>
+ </chapter>
+
+ <chapter xml:id="shell">
+ <title>Shell</title>
+
+ <para></para>
+ </chapter>
+
+ <chapter xml:id="thrift">
+ <title>Thrift</title>
+
+ <para></para>
+ </chapter>
+
+ <chapter xml:id="rest">
+ <title>REST</title>
+
+ <para></para>
+ </chapter>
+</book>
Added: hbase/trunk/src/docbkx/sample_article.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/docbkx/sample_article.xml?rev=979124&view=auto
==============================================================================
--- hbase/trunk/src/docbkx/sample_article.xml (added)
+++ hbase/trunk/src/docbkx/sample_article.xml Sun Jul 25 21:34:46 2010
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<article version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <info>
+ <title>Wah-wah
+<?eval ${project.version}?>
+ </title>
+
+
+ </info>
+
+ <section xml:id="wahwah">
+ <title>Wah-Wah changed my life</title>
+
+ <para>I was born very young...</para>
+
+ <para>This is a sample docbook article.</para>
+ <para>
+ <?eval ${project.version}?>
+ </para>
+
+ <section xml:id="then">
+ <title>Then</title>
+
+ <para></para>
+ </section>
+
+ <section xml:id="and">
+ <title>And</title>
+
+ <para></para>
+ </section>
+
+ <section xml:id="later">
+ <title>Later</title>
+
+ <para></para>
+ </section>
+ </section>
+
+ <section xml:id="good_books">
+ <title>Good books</title>
+
+ <para></para>
+ </section>
+
+ <section xml:id="rainy_days">
+ <title>Rainy days</title>
+
+ <para>Today it was raining</para>
+ </section>
+</article>
Modified: hbase/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/site.xml?rev=979124&r1=979123&r2=979124&view=diff
==============================================================================
--- hbase/trunk/src/site/site.xml (original)
+++ hbase/trunk/src/site/site.xml Sun Jul 25 21:34:46 2010
@@ -37,6 +37,8 @@
<item name="HBase on Windows" href="cygwin.html" />
<item name="Cluster replication" href="replication.html" />
<item name="Pseudo-Distributed HBase" href="pseudo-distributed.html" />
+ <item name="HBase Book" href="book.html" />
+ <item name="Example Docbook Article" href="sample_article.html" />
</menu>
</body>
<skin>