Documentation project

The ServiceMix documentation project aims to build a set of manuals for ServiceMix using Scalate.

Sample output

For ServiceMix 4.3-SNAPSHOT: http://servicemix.apache.org/docs/4.3.0-SNAPSHOT/

Source code

The source code for this project can be found at

• https://svn.apache.org/repos/asf/servicemix/documentation/
• git://git.apache.org/servicemix-documentation.git

Branches:

• trunk refers to the next development version of ServiceMix (currently 4.3-SNAPSHOT)

Prerequisites

Before being able to build and run this project, you need to download and install:

• Pygments : http://pygments.org/download/
• Prince XML : http://princexml.com/download/

Project layout

The project is a basic Maven WAR project. Some important directories and files in the project:

• 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

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

You can also deploy the site directly by running mvn scalate:deploy afterwards, provided you have set up the correct credentials for people.apache.org in ~/.m2/settings.xml:

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <servers>
    <server>
      <id>people.apache.org</id>
      <username>gertv</username>
      <!-- either one of these authentication methods -->
      <privateKey/>
      <password/>
    </server>
  </servers>
  
</settings>

Hudson builds

A Hudson build has been set up for trunk in http://hudson.zones.apache.org/hudson/job/ServiceMix-Docs/