Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Table of Contents

There is a separate SVN directory for the website. It's built using Apache Forrest.

Setup environment

Checkout the website

No Format
$ svn co http://svn.apache.org/repos/asf/hive/site/ hive-site
$ cd hive-site

Setup Apache Forrest

At the time of this writing the Apache Forrest project is distributed as two tar files, one sources and one dependencies. You need both of this files. Here is how I installed it:

No Format
$ tar -zxvf apache-forrest-0.9-sources.tar.gz
$ tar -zxvf apache-forrest-0.9-dependencies.tar.gz
$ mv apache-forrest-0.9 /usr/local/
$ export FORREST_HOME=/usr/local/apache-forrest-0.9/
$ export PATH=$PATH:$FORREST_HOME/bin

Contribute a patch

Make some changes

No Format
$ vim author/src/documentation/path/to/somefile.xml # (make some change)
$ svn add author/src/documentation/path/to/somefile.xml (add some file)

Build the site

No Format
$ ant

If the build was a success you should be able to preview the changes via the local publish/ directory in your browser. The output will contain PDF's which don't work well with patches. Therefore we will revert the publish/ directory to create a patch which can then be reviewed.

No Format
$ svn revert -R publish/

Create a patch

No Format
$ svn diff > /tmp/HIVE-XXXX.patch

Commit a patch

No Format
$ cd hive-site
$ patch -p0 --dry-run < /tmp/HIVE-XXXX.path
$ patch -p0 < /tmp/HIVE-XXXX.path
$ ant

If the build was a success you should be able to preview the changes via the local publish/ directory in your browser. If the output looks good you can commit it:

No Format
$ svn commit -m "...."