SEPTEMBER 22, 2019 THE CONTENT IN THIS REPO IS OUT OF DATE. YOU CAN FIND UP-TO-DATE SYNDESIS DOCUMENTATION HERE: https://github.com/syndesisio/syndesis/tree/master/doc

Documentation for Syndesis - a platform for running JBoss Fuse on the enterprise public cloud (OpenShift Dedicated).

Syndesis source documentation is written in Asciidoc. See the Style Guide for JBoss Fuse Documentation, which is in this repository in the asciidoc folder.

The instructions below get you started with Asciidoc.

== FAQ

Q. I'm new to Asciidoc. How do I get this stuff to work?

This project is configured to build the docs using the asciidoctor-maven-plugin and tooltips are extracted using the syndesis-documentation-maven-plugin. Before you build the docs for the first time, build and install the syndesis-documentation-maven-plugin locally, as follows:

cd tools mvn install

To build the docs, run Maven from the top-level directory, as follows:

mvn package

Q. Where can I learn about Asciidoc syntax?

See the http://asciidoctor.org/docs/user-manual/[Asciidoc User Manual].