Metron's Site Book is an attempt at producing documentation that is:
The idea is that a release manager would build the site-book (following the instructions below), then publish it from the public Metron site as the docs for the new released version. Older site-book versions should remain available for users that need them.
The site-book is also part of the Maven site lifecycle, and will be included by the full site from the top level. However, the site as a whole takes longer than just the site-book:
To build only the book, do the following:
In any git clone of metron containing the site-book subdirectory,
cd site-book mvn site
It only takes a few seconds. You may now view your copy of the book in a browser by opening
file:///your/path/to/metron/site-book/target/site/index.html
On a Mac, you can just type the following on the command line
open target/site/index.html