How to Build the Rampart Project's Website

Installing Maven2

The Apache Rampart website build system solely depends on Maven2. The build has been specifically tested to work with Maven version 2.0.7. To install Maven, download the distributions and follow the instructions in the documentation. Make sure you don't forget to add MAVEN_HOME/bin directory in the path.

Checking out Apache Rampart

Checkout the latest source using your favorite SVN client. If you are a committer, get a commiter check out.

Building the Site

cd to modules/documentation and type mvn install The built site will be available under target/site.

FAQ

  1. How can I update a document in the site ?
    Get a commiter check out. All the documents are in XHTML format under the modules/documentation/src/site/xdoc folder, and you can change only the documents found under this folder. Change the relevant file and run mvn install. New documentation will be available under the target folder.
  2. How can I add a new document?
    Add the new document in the xdoc folder. Change the site.xml found under the modules/documentation/src/site folder by adding a link to the newly added document. Re-generate the site.
    Please make sure you have not included any of the illegal characters and your document should be well formed.