[
https://issues.apache.org/jira/browse/METRON-716?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15864773#comment-15864773
]
ASF GitHub Bot commented on METRON-716:
---------------------------------------
Github user JonZeolla commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/454#discussion_r100936871
--- Diff: site-book/README.md ---
@@ -0,0 +1,50 @@
+# Metron Site-Book documentation
+
+Metron's Site Book is an attempt at producing documentation that is
+
+- Versioned and reviewed
+- Tied to code versions
+- Highly local to the code being documented
+
+The idea is that a release manager would build the site-book (following
the instructions below), then publish it from the public [Metron
site](http://metron.incubator.apache.org/) 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
+```
+
+The key files under site-book are:
+
+###bin/generate-md.sh
+
+- Copies all .md files from the code directory tree into the site tree
+- Performs some transformations on them
+- Generates the nav tree structure and labels
+
+###bin/fix-md-dialect.awk
+
+- Is called by 'generate-md.sh'
+- It does transforms within the text of each file
--- End diff --
Suggest changing this into:
- Called by `generate-md.sh`
- Does transforms within the text of each file
> Add README.md to site-book
> --------------------------
>
> Key: METRON-716
> URL: https://issues.apache.org/jira/browse/METRON-716
> Project: Metron
> Issue Type: Bug
> Reporter: Matt Foley
> Assignee: Otto Fowler
>
> [~ottobackwards] correctly notes that the new Site-Book element should have a
> README.md describing the contents, and how to build it.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
