Google Git
Sign in
apache / servicemix-documentation / refs/heads/servicemix-5.x
commit6f63e3d9a90f6f56f89d25027d8e2759106b18b9[log] [tgz]
authorGert Vanthienen <gertv@apache.org>Wed May 28 09:54:15 2014 +0000
committerGert Vanthienen <gertv@apache.org>Wed May 28 09:54:15 2014 +0000
treef7b1b3b129a0a8183032f58de29dab67484f52f5
parent63e9ea844fa37c7ffa3bd318d52506d8f68005ff [diff]
Set up branch for publishing to http://servicemix.apache.org/docs/5.x

git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/branches/servicemix-5.x@1597956 13f79535-47bb-0310-9956-ffa450edef68
1 file changed
tree: f7b1b3b129a0a8183032f58de29dab67484f52f5
  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