Github user JonZeolla commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/454#discussion_r100899121
--- Diff: site-book/README.md ---
@@ -0,0 +1,42 @@
+# Site Book Metron documentation
+
+Metron's Site Book is an attempt at producing documentation that is
+
+-Versioned and reviewed,
+- Only committers can edit
+- Tied to code versions
+- Highly local to the code being documented
+
+Currently it is in a stand-alone, versioned-with-the-code sub-directory
and sub-project. The idea is that a release
+manager would build the site-book (following the instructions below), then
copy it into a versioned subdirectory of the (unversioned) public site, to
publish it along with each code release.
+
+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
--- End diff --
Wrap in ``` ?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
