[
https://issues.apache.org/jira/browse/METRON-716?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15864577#comment-15864577
]
ASF GitHub Bot commented on METRON-716:
---------------------------------------
Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/454#discussion_r100912944
--- Diff: site-book/README.md ---
@@ -0,0 +1,51 @@
+# 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.
--- End diff --
suggest instead this sentence to read:
"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."
> 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)
