Google Git
Sign in
apache / servicemix-documentation / 1d71ed62ff1e5d3313aa7388ee6d3adea4b893c3
commit1d71ed62ff1e5d3313aa7388ee6d3adea4b893c3[log] [tgz]
authorKrzysztof Sobkowiak <ksobkowiak@apache.org>Fri Feb 12 21:53:22 2016 +0000
committerKrzysztof Sobkowiak <ksobkowiak@apache.org>Fri Feb 12 21:53:22 2016 +0000
tree17a214edd50a27d1f359a8ff68e21c1d6daf2ed6
parent590151451cdc54503094791d800063e42d158bbf [diff]
Upgrade to ServiceMix 7


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