You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/04/05 01:21:41 UTC
[jira] [Commented] (METRON-823) bro-plugin-kafka/README.md has
Markdown usages not compatible with site-book
[ https://issues.apache.org/jira/browse/METRON-823?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15956150#comment-15956150 ]
ASF GitHub Bot commented on METRON-823:
---------------------------------------
GitHub user mattf-horton opened a pull request:
https://github.com/apache/incubator-metron/pull/511
METRON-823 bro-plugin-kafka/README.md has Markdown usages not compatible with site-book
Current version of metron-sensors/bro-plugin-kafka/README.md has Markdown usages not compatible with site-book:
1. usages of code blocks by indenting without triple back-ticks.
2. usages of double back-tick, should be single.
It fails to run correctly with site-book/bin/generate-md.sh.
This patched version looks right in both Github-MD and doxia-markdown, and passes successfully through site-book/bin/generate-md.sh.
## Pull Request Checklist
### 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 code changes: N/A
### 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
```
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/mattf-horton/incubator-metron METRON-823
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/511.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 #511
----
commit 888bcd7b9987695180991df3feda6962ee1d79a3
Author: mattf-horton <mf...@hortonworks.com>
Date: 2017-04-05T01:15:07Z
METRON-823 bro-plugin-kafka/README.md has Markdown usages not compatible with site-book
----
> bro-plugin-kafka/README.md has Markdown usages not compatible with site-book
> ----------------------------------------------------------------------------
>
> Key: METRON-823
> URL: https://issues.apache.org/jira/browse/METRON-823
> Project: Metron
> Issue Type: Bug
> Reporter: Matt Foley
>
> This README file shows correctly in Github-MD, but doesn't succeed with site-book/bin/generate-md. Need to change:
> 1. usages of code blocks by indenting without triple back-ticks.
> 2. usages of double back-tick, should be single.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)