[Proposal]

Installation guide

Documentation that explains how to install the Hawkular project and dependencies (database/Cassandra...) for the people who wants to have the server installed locally.

Deliverable: Downloadable zip or PDF on hawkular.org + online documentation on hawkular.org

Tools: AsciiDoc + Git

Reference guide

Documents the public APIs and how to customize the project (Create new plugins, add new feeds...)

Would also include the REST API.

Deliverable: Downloadable zip or PDF on hawkular.org + online documentation on hawkular.org

Tools: AsciiDoc + Git, swagger for REST API, Javadoc for Java API

User guide

Documentation about using Hawkular once installed, how to monitor, how to create a new alert...

The online documentation will be referenced from the SaaS running on hawkular.io

Deliverable: Downloadable zip or PDF on hawkular.org + online documentation on hawkular.io ( + online documentation on hawkular.org ?)

Tools: AsciiDoc + Git