Documentation project

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

Links

For ServiceMix 4.3-SNAPSHOT

• Programmer's Guide (One-page HTML) (HTML) (PDF)
• JBI Reference Guide (One-page HTML) (HTML) (PDF)

Source code

The source code for this project can be found at https://svn.apache.org/repos/asf/servicemix/documentation/

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

Content can be added in two formats:

• pure DocBook XML source files go in the src/docbkx folder
• a Confluence-alike wiki markup can be used in src/confluence

Project layout

• common : common files (xsl, css, ...)
• docs : common maven plugin setup for underlying projects
• docs/manual : Programmer's Manual
• docs/jbi : JBI Reference Manual

Building and deploying

The documentation can be built by running mvn clean install on the documentation project.

You can also deploy the site directly by running mvn site: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/