[
https://issues.apache.org/jira/browse/METRON-959?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16013974#comment-16013974
]
ASF GitHub Bot commented on METRON-959:
---------------------------------------
GitHub user JonZeolla opened a pull request:
https://github.com/apache/metron/pull/591
METRON-959 Trivial documentation formatting bugs
## Contributor Comments
I noticed there were some bugs rendering README.md files in GitHub MD, so I
did a quick search by cloning the metron repo and then running `egrep -r
"^#{1,6}[a-zA-Z]" * | grep -i README.md | cut -f1 -d\: | sort -u` from the
metron folder and then manually adding spaces between `#` symbols and the
header text where necessary.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
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
Guidelines](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
mvn 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.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/JonZeolla/metron METRON-959
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/591.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 #591
----
commit 2c3ccca721b28cf4563a49a2b3504d009a9bccb7
Author: Jon Zeolla <[email protected]>
Date: 2017-05-17T12:53:46Z
METRON-959 Trivial documentation formatting bugs
----
> Trivial documentation formatting bugs
> -------------------------------------
>
> Key: METRON-959
> URL: https://issues.apache.org/jira/browse/METRON-959
> Project: Metron
> Issue Type: Improvement
> Reporter: Jon Zeolla
> Assignee: Jon Zeolla
> Priority: Trivial
>
> Fix some trivial documentation formatting bugs scattered across README.md
> files
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
