You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by mi...@apache.org on 2014/09/18 04:59:57 UTC
git commit: HBASE-11951 Add a script to assist with publishing the
website and getting rid of stale files
Repository: hbase
Updated Branches:
refs/heads/master 5cba49c5b -> e4a766150
HBASE-11951 Add a script to assist with publishing the website and getting rid of stale files
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo
Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/e4a76615
Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/e4a76615
Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/e4a76615
Branch: refs/heads/master
Commit: e4a7661505140c6fe84d2a9e7eee014f1a6535b0
Parents: 5cba49c
Author: Misty Stanley-Jones <ms...@cloudera.com>
Authored: Thu Sep 18 12:59:19 2014 +1000
Committer: Misty Stanley-Jones <ms...@cloudera.com>
Committed: Thu Sep 18 12:59:31 2014 +1000
----------------------------------------------------------------------
src/main/docbkx/developer.xml | 42 ++++++++++++++++----------------------
1 file changed, 18 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/hbase/blob/e4a76615/src/main/docbkx/developer.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/developer.xml b/src/main/docbkx/developer.xml
index ed76acc..3224834 100644
--- a/src/main/docbkx/developer.xml
+++ b/src/main/docbkx/developer.xml
@@ -808,30 +808,24 @@ $ rsync -av 0.96.0RC0 people.apache.org:public_html
>hbase.apache.org</link></title>
<para>As of <link xlink:href="https://issues.apache.org/jira/browse/INFRA-5680"
>INFRA-5680 Migrate apache hbase website</link>, to publish the website, build
- it, and then deploy it over a checkout of
- <filename>https://svn.apache.org/repos/asf/hbase/hbase.apache.org/trunk</filename>.
- Finally, check it in. For example, if trunk is checked out out at
- <filename>/Users/stack/checkouts/trunk</filename> and the hbase website,
- hbase.apache.org, is checked out at
- <filename>/Users/stack/checkouts/hbase.apache.org/trunk</filename>, to update
- the site, do the following:</para>
- <programlisting language="bourne">
-# 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 before you invoke 'site'.
-$ mvn clean install -DskipTests javadoc:aggregate site \
- site:stage -DstagingDirectory=/Users/stack/checkouts/hbase.apache.org/trunk
- </programlisting>
- <para>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
- <link xlink:href="http://hbase.apache.org">http://hbase.apache.org</link>.</para>
- <programlisting language="bourne">
-$ 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...'
- </programlisting>
+ it using Maven, and then deploy it over a checkout of
+ <filename>https://svn.apache.org/repos/asf/hbase/hbase.apache.org/trunk</filename>
+ and check in your changes. The script
+ <filename>dev-scripts/publish_hbase_website.sh</filename> is provided to
+ automate this process and to be sure that stale files are removed from SVN. Review
+ the script even if you decide to publish the website manually. Use the script as
+ follows:</para>
+ <screen>$ <userinput>publish_hbase_website.sh -h</userinput>
+<![CDATA[Usage: publish_hbase_website.sh [-i | -a] [-g <dir>] [-s <dir>]]]>
+ -h Show this message
+ -i Prompts the user for input
+ -a Does not prompt the user. Potentially dangerous.
+ -g The local location of the HBase git repository
+ -s The local location of the HBase svn checkout
+ Either --interactive or --silent is required.
+ Edit the script to set default Git and SVN directories.
+ </screen>
+ <note><para>The SVN commit takes a long time.</para></note>
</section>
</section>
<section xml:id="hbase.tests">