diff --git a/src/main/docbkx/developer.xml b/src/main/docbkx/developer.xml
index d9e9b97a309..50867622e66 100644
--- a/src/main/docbkx/developer.xml
+++ b/src/main/docbkx/developer.xml
@@ -325,8 +325,16 @@ What is the new development version for "HBase"? (org.apache.hbase:hbase) 0.92.3
Updating hbase.apache.orgContributing to hbase.apache.org
- The Apache HBase apache web site (including this reference guide) is maintained as part of the main Apache HBase source tree, under /src/docbkx and /src/site. The former is this reference guide; the latter, in most cases, are legacy pages that are in the process of being merged into the docbkx tree.
- To contribute to the reference guide, edit these files and submit them as a patch (see ). Your Jira should contain a summary of the changes in each section (see HBASE-6081 for an example).
+ The Apache HBase apache web site (including this reference guide) is maintained as part of the main
+ Apache HBase source tree, under /src/main/docbkx and /src/main/site
+ Before 0.95.0, site and reference guide were at src/docbkx and src/site respectively.
+ The former -- docbkx -- is this reference guide as a bunch of xml marked up using docbook;
+ the latter is the hbase site (the navbars, the header, the layout, etc.),
+ and some of the documentation, legacy pages mostly that are in the process of being merged into the docbkx tree that is
+ converted to html by a maven plugin by the site build.
+ To contribute to the reference guide, edit these files under site or docbkx and submit them as a patch
+ (see ). Your Jira should contain a summary of the changes in each
+ section (see HBASE-6081 for an example).To generate the site locally while you're working on it, run:
mvn site
Then you can load up the generated HTML files in your browser (file are under /target/site).
@@ -334,20 +342,22 @@ What is the new development version for "HBase"? (org.apache.hbase:hbase) 0.92.3
Publishing hbase.apache.orgAs of INFRA-5680 Migrate apache hbase website,
- to publish the website, build it, and then deploy it over a checkout of https://svn.apache.org/repos/asf/hbase/hbase.apache.org/trunk,
- and then check it in. For example, if trunk is checked out out at /Users/stack/checkouts/trunk
- and hbase.apache.org is checked out at /Users/stack/checkouts/hbase.apache.org/trunk, to update
+ to publish the website, build it, and then deploy it over a checkout of https://svn.apache.org/repos/asf/hbase/hbase.apache.org/trunk.
+ Finally, check it in. For example, if trunk is checked out out at /Users/stack/checkouts/trunk
+ and the hbase website, hbase.apache.org, is checked out at /Users/stack/checkouts/hbase.apache.org/trunk, to update
the site, do the following:
# Build the site and deploy it to the checked out directory
- # Getting the javadoc into site is a little tricky. You have to build it independent, then
- # 'aggregate' it at top-level so the pre-site site lifecycle step can find it; that is
- # what the javadoc:javadoc and javadoc:aggregate is about.
- $ MAVEN_OPTS=" -Xmx3g" mvn clean -DskipTests javadoc:aggregate site site:stage -DstagingDirectory=/Users/stack/checkouts/hbase.apache.org/trunk
- # Check the deployed site by viewing in a brower.
- # If all is good, commit it and it will show up at http://hbase.apache.org
- #
+ # Getting the javadoc into site is a little tricky. You have to build it before you invoke 'site'.
+ $ MAVEN_OPTS=" -Xmx3g" mvn clean install -DskipTests javadoc:aggregate site site:stage -DstagingDirectory=/Users/stack/checkouts/hbase.apache.org/trunk
+
+ Now check the deployed site by viewing in a brower, browse to file:////Users/stack/checkouts/hbase.apache.org/trunk/index.html and check all is good.
+ If all checks out, commit it and your new build will show up immediately at http://hbase.apache.org
+
$ cd /Users/stack/checkouts/hbase.apache.org/trunk
+ $ svn status
+ # Do an svn add of any new content...
+ $ svn add ....
$ svn commit -m 'Committing latest version of website...'