Website Update HOWTO

What you need

Apache Forrest - Publishing framework used for Nutch Website maintenance.

How to modify the docs

1. Checkout nutch code.

2. Go to src/site. It is the root of Nutch Website Forrest project.

3. Run forrest to build current version of documentation. If the build was successful it means Forrest was correctly installed and generated site is in src/site/build/site directory.

4. Modify files in src/site/src (mainly in src/site/src/documentation/content/xdocs). Run forrest in /src/site and review the changes after build.

If you aren't a committer for this project, you now need to follow the instructions in HowToContribute to get your changes applied to the site. You'll specifically want to read the sections on "Creating a patch" and "Proposing your work". If you are a committer, it's time to deploy the site.

How to deploy the site

1. When you are finally happy with your changes copy files from src/site/build/site directory to site and commit them to SVN.

2. ssh people.apache.org

3. cd /www/lucene.apache.org/nutch

4. Before doing svn up make sure your umask is set to 002 (if you're using bash check that ~/.profile contains umask 002), this allows other committers to update the site too

5. svn update

6. Wait a few hours. The website is synchronized from people.apache.org.