The ServiceMix documentation project aims to build a set of manuals for ServiceMix using Scalate.
It's currently used to generate the contents for:
Browsing the Source Tree
Web Browsing of SVN
To browse the raw SVN repo, use the following URL:
To browse the SVN repo using ViewVC, use the following URL:
A hearty thanks to Atlassian for providing FishEye hosting for ServiceMix. Below is the URL to browse the Subversion repo via FishEye:
Checking out the Source Tree
Anonymous Checkout from the ServiceMix SVN Repo
This project's SVN repository can be checked out anonymously using the following command:
svn co http://svn.apache.org/repos/asf/servicemix/documentation/trunk/
Using the git mirror
There was a git mirror set up for the documentation project at git://git.apache.org/servicemix-documentation.git.
Have a look at http://wiki.apache.org/general/GitAtApache for more information on working with the git mirrors.
git clone git://git.apache.org/servicemix-documentation.git
Committer Checkout from the ServiceMix SVN Repo
ServiceMix committers can check out using the following command:
svn co https://svn.apache.org/repos/asf/servicemix/documentation/trunk/
Only project developers can commit to the SVN tree via this method. SSH must be installed on your client machine. Enter your site password when prompted.
The project is a basic Maven WAR project. Some important directories and files in the project:
src/main/webapp : Contains the documentation page contents
src/main/webapp/commands : TOC and index files for Console Commands manual section
src/main/webapp/karaf : TOC and index files for Karaf manual section
src/main/webapp/users-guide : The ServiceMix User's Guide section
src/main/webapp/WEB-INF/scalate/layouts : Scalate SSP templates for the site
Building and deploying
Before being able to build and run this project, you need to download and install:
Static website and WAR
The documentation website and WAR can be built by running mvn clean install on the documentation project. This will create and install:
target/sitegen: a local copy of the static website
A WAR file for installing the documentation on an application server
If Prince XML has been installed, it will also create the PDF manuals
Live website for editing
Running mvn jetty:run in the documentation project allows you to preview the resulting website on http://localhost:8080. Just edit any page and hit refresh in the browser to have a look at the result.
Deploying a new documentation site copy
If you're a committer, you can also deploy the site directly by running mvn scm-publish:publish-scm afterwards. This will upload a new copy to https://svn.apache.org/repos/asf/servicemix/site/production/.
A Hudson build has been set up for trunk in http://hudson.zones.apache.org/hudson/job/ServiceMix-Docs/