Google Git
Sign in
apache / servicemix-documentation / aebf5a2a737f4fd5c09fb45035aea049919b5c23
commitaebf5a2a737f4fd5c09fb45035aea049919b5c23[log] [tgz]
authorKrzysztof Sobkowiak <ksobkowiak@apache.org>Fri Feb 12 22:31:12 2016 +0000
committerKrzysztof Sobkowiak <ksobkowiak@apache.org>Fri Feb 12 22:31:12 2016 +0000
tree6d551b56dc350eeee3b94982109abbb5f155bf59
parent1d71ed62ff1e5d3313aa7388ee6d3adea4b893c3 [diff]
revertion Karaf upgrade causing problems while generating the docs


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