ENT-11371 MPF.md: Fixed many inconsistencies

[olehermanse]

This file is shown in our docs and could use a cleanup.

Went over this file trying to fix as many obvious / easy inconsistencies as I could:

• Removed the use of h1, h5 and h6 headings.
• Added JSON highlighting to code blocks.
• Fixed invalid JSON (trailing commas, missing colons).
• Fixed inconsistent indentation / formatting of code blocks.
• Fixed capitalization of several headers to use sentence case.
• Fixed capitalization of CFEngine, HTTP, HTTPS, etc. in a few places.
• Added monospace font for binaries; cf-serverd, etc.
• Fixed inconsistent markdown syntax (especially what should be bold and which symbols to use for bulleted lists).
• Fixed small typos / grammer mistakes.
• Renamed some headings to make them easier to understand.

Ticket: ENT-11371

[larsewi]

💩

[craigcomstock]

good changes generally.

I would prefer we did one line per sentence style here but I guess some folks will read this in a console so 80-ish columns makes some sense.

thanks for all this busy work! appreciate it!

[nickanderson]

I opened a PR in docs to see the result of this: cfengine/documentation#3221

[nickanderson]

good changes generally.

I would prefer we did one line per sentence style here but I guess some folks will read this in a console so 80-ish columns makes some sense.

thanks for all this busy work! appreciate it!

humm, maybe we add the necessary doc comments to enable line wrapping in the editors. I sort of prefer 80 column limit but do find myself using long lines with visual wrapping more and more.

[olehermanse]

I would prefer we did one line per sentence style here but I guess some folks will read this in a console so 80-ish columns makes some sense.

@craigcomstock I would also prefer it, but it didn't seem worth it, big file to edit.

[olehermanse]

@nickanderson @craigcomstock IMO, it should be preferred, for the same reasons as in website repo:

https://github.com/cfengine/website/blob/master/README.md#sentences-and-wrapping

However, it's a big change and would require a lot of going around editing files manually, so I'm not about to venture down this path of doing it everywhere and making it required.

In other words: it's recommended for now.

[nickanderson]

Just a couple suggestions.

[nickanderson]

So fast docbuild won't pick up these changes until they are found in the nightly package.

[olehermanse]

Backport: #2836