Google Git
Sign in
apache / servicemix-documentation / ef6c6c70bfec3c7707d988c40232b0df7494e19f
commitef6c6c70bfec3c7707d988c40232b0df7494e19f[log] [tgz]
authorGert Vanthienen <gertv@apache.org>Wed May 28 07:51:54 2014 +0000
committerGert Vanthienen <gertv@apache.org>Wed May 28 07:51:54 2014 +0000
tree178eee7cf8a14b9a5e7e05d772890e9d6fc17cb6
parent97cc4249e53d137542a2544a416d0e1f3c16d29b [diff]
SM-2289: Remove ActiveMQ fix in quickstart guide from SM-2269
         Thanks to Wim Verreydt for the pull request!
         This closes #3

git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/trunk@1597933 13f79535-47bb-0310-9956-ffa450edef68
1 file changed
tree: 178eee7cf8a14b9a5e7e05d772890e9d6fc17cb6
  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