Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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

Source code

The source code for this project can be found at

...

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

Project layout

...

  • 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:

...

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

Note
titleNo automatic deployment

At the moment, we're unable to deploy updates to the documentation automatically from the Hudson builds.