metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From JonZeolla <...@git.apache.org>
Subject [GitHub] incubator-metron pull request #470: METRON-752 Fix documentation typos and M...
Date Fri, 03 Mar 2017 21:14:19 GMT
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 <zeolla@gmail.com>
Date:   2017-03-03T16:05:45Z

    METRON-752 Fix documentation typos and MD issues

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message