* Improves multicluster documentation
Improve documentation based upon fresh eyes running through the
documented process.
* Address reviewer comments.
* More refinement.
* Exclude rule MD028
Rule 028 is: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md028---blank-line-inside-blockquote
The rationale below cut and pasted from markdownlint seems
valid for the general case, however, our MD parser always
produces seprate block-quotes, which is what I am after in
this PR. I think other people will prefer our renders of
blockquotes (separate blockquotes);
Rationale: Some markdown parsers will treat two blockquotes
separated by one or more blank lines as the same blockquote,
while others will treat them as separate blockquotes.
Instead of having to have two PRE blocks, one for commands and one for the output,
we can now have a single PRE block and we take care of rendering things to show the
command vs. the output. The Copy button on such a thing only copy the command, and not
the output.
We now also show a $ on command-lines, but the Copy button doesn't copy that and knows to just
copy the usable part of the command-line.
- linters.sh will run spell-checking and a style checker on
markdown files.
- Fix a whole bunch of typos and bad markdown content throughout. There are many more fixes
to come before we can enable the linters as a checkin gate, but this takes care of a majority
of items. More to come later.
Martin Taillefer
Steven Dake
mtail