hbase-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From st...@apache.org
Subject svn commit: r1425977 - /hbase/trunk/src/docbkx/developer.xml
Date Wed, 26 Dec 2012 18:12:46 GMT
Author: stack
Date: Wed Dec 26 18:12:46 2012
New Revision: 1425977

URL: http://svn.apache.org/viewvc?rev=1425977&view=rev
Add note on how to generate the manual


Modified: hbase/trunk/src/docbkx/developer.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/docbkx/developer.xml?rev=1425977&r1=1425976&r2=1425977&view=diff
--- hbase/trunk/src/docbkx/developer.xml (original)
+++ hbase/trunk/src/docbkx/developer.xml Wed Dec 26 18:12:46 2012
@@ -308,6 +308,19 @@ What is the new development version for 
 [INFO] -----------------------------------------------------------------------</programlisting>
+      <section xml:id="documentation">
+          <title>Generating the HBase Reference Guide</title>
+          <para>The manual is marked up using <link xlink:href="http://www.docbook.org/">docbook</link>.
+              We then use the <link xlink:href="http://code.google.com/p/docbkx-tools/">docbkx
maven plugin</link>
+              to transform the markup to html.  This plugin is run when you specify the <command>site</command>
+              goal as in when you run <command>mvn site</command> or you can
call the plugin explicitly to
+              just generate the manual by doing <command>mvn docbkx:generate-html</command>
+              (TODO: It looks like you have to run <command>mvn site</command>
first because docbkx wants to
+              include a transformed <filename>hbase-default.xml</filename>. 
+              When you run mvn site, we do the document generation twice, once to generate
the multipage
+              manual and then again for the single page manual (the single page version is
easier to search).
+          </para>
+      </section>
     <section xml:id="hbase.org">
     <title>Updating hbase.apache.org</title>
       <section xml:id="hbase.org.site.contributing">

View raw message