markdown: fix grammar/formatting, standardize on markdown

[rpjday]

While fixing grammar and list formatting issues, standardize on
markdown as follows:

• commands are marked by '**'
• files are marked by backquotes
• list items are marked with leading '-'

Signed-off-by: Robert P. J. Day rpjday@crashcourse.ca

[openshift-ci-robot]

Hi @rpjday. Thanks for your PR.

I'm waiting for a containers member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[TomSweeneyRedHat]

/ok-to-test

[TomSweeneyRedHat]

LGTM

[rhatdan]

/lgtm
Thanks @rpjday

[ssbarnea]

That is clearly desired but without any regression measure is hard to keep the quality.
How about adding markdownlint to the linters? The only issue with it is that is ruby based.

[rpjday]

I'm still trying to figure out what flavour of Markdown is being used. I spent some time yesterday perusing the Intertoobz for MD references, and there are all these subtle variations. And the more I learned, the more I realized that there are a lot of subtle errors in the man page .md files that generate bad rendering. I'd love it if there was a definitive reference for what is being used here.

[rhatdan]

Well the markdown is for display on github.com, we really do not share it in other places.

[mheon]

/approve

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mheon, rpjday

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [mheon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment