[
https://issues.apache.org/jira/browse/METRON-716?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15864769#comment-15864769
]
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_r100936329
--- 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.
--- End diff --
Do we actually have a process for the release manager to follow that
includes this? It should probably exist
[here](https://cwiki.apache.org/confluence/display/METRON/Release+Process). If
I'm not missing it, I will happily suggest an update to the wiki via the dev
list.
> 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)
