*: Address markdown linting violations in various documentation files

operator-framework / olm-docs

Hugo doc site for https://github.com/operator-framework/operator-lifecycle-manager

10 stars 82 forks source link

*: Address markdown linting violations in various documentation files #99

Closed timflannagan closed 3 years ago

timflannagan commented 3 years ago

Update the context/* documentation files:

Add code formatting blocks.
Normalize punctuation in lists.
Add newline between headings and text.
Add newline between text and first list element.
Add missing trailing newlines.
Remove any redundant newlines.
Remove any redundant spaces.

exdx commented 3 years ago

/lgtm

anik120 commented 3 years ago

@timflannagan1 our CI is failing on a few links in the site. Is it possible to fix those links as a part of this PR? Thanks!

timflannagan commented 3 years ago

@timflannagan1 our CI is failing on a few links in the site. Is it possible to fix those links as a part of this PR? Thanks!

Yeah, that's fine with me. I'll play around with running this locally.

timflannagan commented 3 years ago

/retitle *: Address markdown linting violations in various documentation files

timflannagan commented 3 years ago

It looks like I never got around to breaking that WIP/TODO commit into multiple commits, but it also looks like multiple people are trying to contribute to this repository at the same time. In order to make sure others don't have to rebase constantly, I'm going to merge this without fixing that commit message.