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.
To build the book, do the following:
In any git clone of incubator-metron containing the site-book subdirectory,
cd site-book bin/generate-md.sh mvn site: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/incubator-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
##Key Components:
###bin/generate-md.sh
###bin/fix-md-dialect.py
###pom.xml and src/site/site.xml