You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by JonZeolla <gi...@git.apache.org> on 2017/04/05 01:22:47 UTC
[GitHub] incubator-metron pull request #512: METRON-824 site-book generation is broke...
GitHub user JonZeolla opened a pull request:
https://github.com/apache/incubator-metron/pull/512
METRON-824 site-book generation is broken
## Contributor Comments
Currently, if you attempt to build the site-book on master you get the following error:
```
ERROR OR ERRORS DETECTED:
ERROR: Header specification character (#) detected with indenting. This is presumed to be an error, since it will render as text. If intentional, put a period or other printable character before it.
on line: 16 in file: ./metron-sensors/bro-plugin-kafka/index.md
# curl -L https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz | tar xvz
```
In order to fix this I changed `metron-sensors/bro-plugin-kafka/index.md` to use triple backticks instead of indentation to indicate the code block. This allows it to parse properly in GitHub MD as well as our Doxia site-book docs.
## Pull Request Checklist
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 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
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.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/JonZeolla/incubator-metron METRON-824
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/512.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 #512
----
commit 5379d8c4f44f0bb10760a13cdef4618bd83803b7
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-04-05T01:10:45Z
Use backticks instead of indentation for codeblocks
----
---
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.
---
[GitHub] incubator-metron pull request #512: METRON-824 site-book generation is broke...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla closed the pull request at:
https://github.com/apache/incubator-metron/pull/512
---
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.
---
[GitHub] incubator-metron issue #512: METRON-824 site-book generation is broken
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:
https://github.com/apache/incubator-metron/pull/512
Duplicate of #511 - @mattf-horton beat me by a minute!
---
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.
---
Re: [GitHub] incubator-metron pull request #512: METRON-824 site-book
generation is broke...
Posted by Matt Foley <ma...@apache.org>.
Heh! I submitted similar patch one minute ago!
Great minds must think alike :-)
--Matt
On 4/4/17, 6:22 PM, "JonZeolla" <gi...@git.apache.org> wrote:
GitHub user JonZeolla opened a pull request:
https://github.com/apache/incubator-metron/pull/512
METRON-824 site-book generation is broken
## Contributor Comments
Currently, if you attempt to build the site-book on master you get the following error:
```
ERROR OR ERRORS DETECTED:
ERROR: Header specification character (#) detected with indenting. This is presumed to be an error, since it will render as text. If intentional, put a period or other printable character before it.
on line: 16 in file: ./metron-sensors/bro-plugin-kafka/index.md
# curl -L https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz | tar xvz
```
In order to fix this I changed `metron-sensors/bro-plugin-kafka/index.md` to use triple backticks instead of indentation to indicate the code block. This allows it to parse properly in GitHub MD as well as our Doxia site-book docs.
## Pull Request Checklist
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 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
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.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/JonZeolla/incubator-metron METRON-824
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/512.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 #512
----
commit 5379d8c4f44f0bb10760a13cdef4618bd83803b7
Author: Jon Zeolla <ze...@gmail.com>
Date: 2017-04-05T01:10:45Z
Use backticks instead of indentation for codeblocks
----
---
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.
---
[GitHub] incubator-metron pull request #512: METRON-824 site-book generation is broke...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/512#discussion_r109814348
--- Diff: metron-sensors/bro-plugin-kafka/README.md ---
@@ -13,22 +13,28 @@ library for Kafka. This plugin has been tested against the latest release of
librdkafka, which at the time of this writing is v0.9.4. In order to support interacting
with a kerberized kafka, you will need libsasl2 installed
- # curl -L https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz | tar xvz
- # cd librdkafka-0.9.4/
- # ./configure --enable-sasl
- # make
- # sudo make install
+```
+# curl -L https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz | tar xvz
+# cd librdkafka-0.9.4/
+# ./configure --enable-sasl
+# make
+# sudo make install
+```
Then compile this Bro plugin using the following commands.
- # ./configure --bro-dist=$BRO_SRC
- # make
- # sudo make install
+```
+# ./configure --bro-dist=$BRO_SRC
+# make
+# sudo make install
+```
Run the following command to ensure that the plugin was installed successfully.
- # bro -N Bro::Kafka
- Bro::Kafka - Writes logs to Kafka (dynamic, version 0.1)
+```
+# bro -N Bro::Kafka
+Bro::Kafka - Writes logs to Kafka (dynamic, version 0.1)
+```
--- End diff --
PR#511 offers the same, but also changes the double-backticks throughout the document into single backticks. While this usage doesn't raise an error, it does show incorrectly.
Sorry we crossed wires. Apparently we both opened jiras and posted PRs exactly one minute apart! They both are sequentially numbered!
---
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.
---