Apache ServiceMix Documentation

Clone this repo:
  1. f18c0c3 revertion Karaf upgrade causing problems while generating the docs by Krzysztof Sobkowiak · 1 year, 8 months ago trunk
  2. 4073ce3 Upgrade to ServiceMix 7 by Krzysztof Sobkowiak · 1 year, 8 months ago
  3. 3420609 Replace osgi: commands with bundle: commands (closes #4) by Krzysztof Sobkowiak · 2 years ago
  4. 92bd2f8 Set up trunk for publishing to http://servicemix.apache.org/docs/6.x by Gert Vanthienen · 3 years, 5 months ago
  5. bfd1974 Update copyright footer by Gert Vanthienen · 3 years, 5 months ago

Prerequisites

You need to have these two programs installed on your machine:

  • Pygments - syntax highlighting for HTML and PDF
  • Prince XML - converts HTML into PDF for the manual

Building the documentation project

There are two ways of building the documentation project:

  • mvn -Plive jetty:run will make a live website copy available locally. This is very convenient while editing the docs to quickly review the changes you made.
  • mvn clean install will build the documentation project, creating 3 representations:
    • a war file containing the documentation webapp
    • a pdf file (in target/sitegen/manual.pdf)
    • a static website, generated using the same templates (in target/sitegen)

Publishing the documentation to the website

If you're an Apache ServiceMix committer, you can publish a new copy of the documentation pages with this command: mvn clean install scm-publish:publish-scm

Known issues

  • The war file currently can't be deployed on ServiceMix