[jira] [Commented] (METRON-752) Fix documentation typos and MD issues

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

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

ASF GitHub Bot commented on METRON-752:
---------------------------------------

GitHub user JonZeolla opened a pull request:

    https://github.com/apache/incubator-metron/pull/470

    METRON-752 Fix documentation typos and MD issues

    Thank you for submitting a contribution to Apache Metron (Incubating).
    Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.
    Please refer also to our [Build Verification guildlines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.
    
    
    In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
    
    ### For all changes:
    - [X] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel). 
    - [X] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    - [X] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    ### For documentation related changes:
    - [X] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via site-book/target/site/index.html.
    
    ```
    cd site-book
    bin/generate-md.sh
    mvn site:site
    ```
    
    ### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
    It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
    
    
    ### Additional Comments
    During my review I identified two separate issues which I documented in [METRON-753](https://issues.apache.org/jira/browse/METRON-753) and [METRON-754](https://issues.apache.org/jira/browse/METRON-754).  The primary fix here are that the links under the Metron API documentation that contain {name} now work in GitHub md but are still broken in our generated documentation.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/JonZeolla/incubator-metron METRON-752

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-metron/pull/470.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #470
    
----
commit 1fc58420dcf39f1d66278c1abe92f39eee0af2e5
Author: Jon Zeolla <ze...@gmail.com>
Date:   2017-03-03T16:05:45Z

    METRON-752 Fix documentation typos and MD issues

----


> Fix documentation typos and MD issues
> -------------------------------------
>
>                 Key: METRON-752
>                 URL: https://issues.apache.org/jira/browse/METRON-752
>             Project: Metron
>          Issue Type: Bug
>            Reporter: Jon Zeolla
>            Assignee: Jon Zeolla
>            Priority: Trivial
>




--
This message was sent by Atlassian JIRA
(v6.3.15#6346)