METRON-824 site-book generation is broken

[JonZeolla]

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 for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines 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:

• Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
• 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.
• Has your PR been rebased against the latest commit within the target branch (typically master)?

For documentation related changes:

• 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 is set up for your personal repository such that your branches are built there before submitting a pull request.

[JonZeolla]

Duplicate of #511 - @mattf-horton beat me by a minute!

[mattf-apache]

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!