What you need

Apache Forrest - Publishing framework used for Nutch Website maintenance.

How to modify the docs

  1. Checkout nutch site code (https://svn.apache.org/repos/asf/nutch/site)
  2. Go to forrest. 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 forrest/build/site directory. If you get errors in validate-skins-stylesheets see http://forrest.apache.org/docs_0_90/faq.html#oldjing
  4. Modify files in forrest/src (mainly in forrest/src/documentation/content/xdocs). Run forrest in forrest and review the changes after build.

reviewing changes to the site

Type forrest run in your project root to start Forrest's built-in Jetty web server. Once it has started, point your browser at http://localhost:8888/, which will show your website, rendered on demand as each link is followed.

(Alternatively, if you wish to run Forrest from within an existing servlet container, type forrest webapp to build an open webapp in build/webapp/). You can now edit the XML content in build/webapp/content/xdocs and see the changes immediately in the browser.

After this, type forrest validate to ensure that things are in order.

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 forrest/build/site directory to publish and commit both of them from /site to SVN.
  2. The modifications should be visible on the website within a few minutes.

Skins Note

If you take a fresh copy of the website source from svn you will see several warnings as files are not found.

Currently (Jun 2010) the website is still branded with Lucene. Forrest is configured to use the lucene skin. Unfortunately some of the images are missing from svn. You can get those images from lucene itself - or add them to svn if you have permission. It should be our intention to create a new Nutch skin by copying and modifying the old lucene skin. https://issues.apache.org/jira/browse/NUTCH-833

Java 1.6 Note

If you get a fatal error in Forrest and you are using Java 1.6 check to see if it is this problem. Basically you need to upgrade to 0.9-dev and not use the released 0.8 version.

  • No labels