How To Build Web Services Project's Website
Installing Forrest
The Web Services website build system requires two components to perform a build. Ant and forrest.
Specifically the build has been tested to work with Ant version 1.8.X and Forrest 0.9-dev. To install these products download the distributions and follow the instructions in their documentation. Make sure you don't forget to set the environment variables FORREST_HOME and ANT_HOME. The ANT_HOME/bin directory should be in the path.
Checking out ws-site module
Running the Build
The main targets of interest to our users are:
| Target | Description |
|---|---|
| clean | Erase all build work products (ie, everything in the build directory |
| site | Build site |
| replace | Build site and copy to ./targets directory |
| run-forrest (default) | Do clean up and build Site |
For Committers
The procedure to make changes to http://ws.apache.org/ ...
- *cd* into the local "ws-site" SVN dir
- execute "ant"
- execute "ant replace"
- svn commit
- (If you are in a hurry) ssh to www.apache.org, *cd* to /www/ws.apache.org, and execute "svn update"
TIPS
You can check whether ws-site will be successfully built or not by following these procedures.
- cd into the local "ws-site" SVN dir
- execute "forrest run"
- point the browser to http://localhost:8888/ to see the site
- edit the docs *in place* (build/webapp/content/xdocs/...) and see changes via the browser by reloading the page
F.A.Q.
Q1.
I encountered
The <xmlcatalog> data type doesn't support the nested "catalogpath" element.
error, during the build.
Q2.
I see an error like this regarding mirrors.pdf
[java] X [0] mirrors.pdf BROKEN ....
A2.
This is a known issue, but does not affect the site itself.
Q3.
The run-forrest target does not complete because of the mirrors.pdf error, so i can't update the site
A3.
There is another target named 'replace' that does the appropriate work
( more to be come )