[ 
https://issues.apache.org/jira/browse/METRON-716?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15864921#comment-15864921
 ] 

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_r100950331
  
    --- Diff: site-book/README.md ---
    @@ -1,13 +1,14 @@
     # Metron Site-Book documentation
     
    -Metron's Site Book is an attempt at producing documentation that is
    +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:
    --- End diff --
    
    I meant adding an additional newline at the end of this line.  If you [view 
this 
line](https://github.com/ottobackwards/incubator-metron/blob/31b517aeea1e4afb73e45910db523c2660aa8584/site-book/README.md)
 post-parsing you'll see lines 12 and 13 are both together right now.


> 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)

Reply via email to