Google Git
Sign in
apache / servicemix-documentation / refs/heads/servicemix-6.x
commitf11b14e2696db740dbfe887a71c99bd7582f1f1c[log] [tgz]
authorKrzysztof Sobkowiak <ksobkowiak@apache.org>Fri Feb 12 21:41:22 2016 +0000
committerKrzysztof Sobkowiak <ksobkowiak@apache.org>Fri Feb 12 21:41:22 2016 +0000
treed2477cb4ec6075e256538c6020b47bf179821445
parent590151451cdc54503094791d800063e42d158bbf [diff]
Creating branch 6.x


git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/branches/servicemix-6.x@1730115 13f79535-47bb-0310-9956-ffa450edef68
tree: d2477cb4ec6075e256538c6020b47bf179821445
  1. src/
  2. .gitignore
  3. pom.xml
  4. README.md
README.md

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