Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add note on how to generate the manual 

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1425977 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2012-12-26 18:12:46 +00:00
parent 6ec2b50dc6
commit 73b021f90a
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/docbkx/developer.xml
View File

@ -308,6 +308,19 @@ What is the new development version for "HBase"? (org.apache.hbase:hbase) 0.92.3
[INFO] -----------------------------------------------------------------------</programlisting>
</para>
</section>
<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>. Fix).
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">