Google Git
Sign in
apache / servicemix-documentation

Mirror of Apache ServiceMix Documentation

Mirrored from https://github.com/apache/servicemix-documentation.git
Clone this repo:

Branches

  1. aebf5a2 revertion Karaf upgrade causing problems while generating the docs by Krzysztof Sobkowiak · 8 years ago trunk
  2. 1d71ed6 Upgrade to ServiceMix 7 by Krzysztof Sobkowiak · 8 years ago
  3. 5901514 Replace osgi: commands with bundle: commands (closes #4) by Krzysztof Sobkowiak · 9 years ago
  4. d7ba3a8 Set up trunk for publishing to http://servicemix.apache.org/docs/6.x by Gert Vanthienen · 10 years ago
  5. 4dbe082 Update copyright footer by Gert Vanthienen · 10 years 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