Metron-979 markdown errors in site-book

[mattf-apache]

Contributor Comments

Fixed multiple problems in markdown docs, mostly related to triple-backtick codeblocks nesting inside numbered lists. I now understand that blank lines are not allowed within a codeblock nested under a numbered list item, although at the top level (under body text) blank lines in codeblocks are okay.

A few of these changes are for consistency or editorial improvement, but most of them fix actual rendering errors in the doxia site build, without breaking Github rendering.

Pull Request Checklist

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 code changes: N/A

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?
  • Yes, verified in doxia build and in github.

[justinleet]

Unrelated to your change, but you throw a '\' at the end of this line while you're in here?

[mattf-apache]

Done.

[JonZeolla]

Opened a PR against your branch. Generated the documentation and did a fair amount of manual review and couldn't find any broken code blocks, links, etc.

[miharp]

Might consider using service command to better support OS's transitioning to systemd

[mattf-apache]

Hi Mike, thanks for your comment. We are still bridging Centos 6 and 7, and currently this works in both, so I'm going to proceed. But if you wanted to open a Jira to add "if Centos6 do this... else if Centos7 do this..." instructions to this and other doc files with similar needs, it would be a welcome contribution.

[mattf-apache]

Thanks, I'm going to take @JonZeolla and @justinleet 's comments as +1s and get this in for 0.4.0. Thanks.

[justinleet]

@mattf-horton is correct, I am +1 on this. Thanks a lot for working on this, it's great to have.

[JonZeolla]

I was not giving a +1, I found an issue with the documentation so I opened up a PR against your personal repo to fix it and threw in a couple of other small tweaks as well. ...

[mattf-apache]

Hi @JonZeolla , sorry if I moved too fast. I consider your patch to be a valuable contribution in its own right. Since it's non-intersecting with the changes I made, I hereby give it a +1 👍
With your permission I'll commit it under the same jira, credited to you. If you prefer to do so yourself, let me know.

And sorry I misunderstood your statement that you'd opened a PR. I totally misread it.

[JonZeolla]

Go for it. Just trying to make sure it got in under a documentation related Jira without a ton of overhead. Jon

On Fri, Jun 2, 2017, 6:23 PM Matt Foley ***@***.***> wrote: Hi @JonZeolla <https://github.com/jonzeolla> , sorry if I moved too fast. I consider your patch to be a valuable contribution in its own right. Since it's non-intersecting with the changes I made, I hereby give it a +1 👍 With your permission I'll commit it under the same jira, credited to you. If you prefer to do so yourself, let me know. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#605 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABUkJh3bQz-LHdni6Pfka3s3VHSmgV50ks5sAItzgaJpZM4Ntt-l> .

-- Jon