chore: lint README.md

[rexagod]

To primarily avoid conflicts and allow for automations.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rexagod

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 [rexagod]

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

[mrueg]

We already have https://github.com/DavidAnson/markdownlint-cli2 integration, why do we need another markdown formatter/linter?

[rexagod]

markdownlint-cli2 wasn't able to lint the compatibility matrix, owing to which the padding logic would differ before and after the substitution or insertions were performed there. So running a linter that ensured an overall consistent README.md format would ensure no merge conflicts happen owing to matrix padding.

[dashpole]

/assign @CatherineF-dev
/triage accepted

[mrueg]

markdownlint-cli2 wasn't able to lint the compatibility matrix, owing to which the padding logic would differ before and after the substitution or insertions were performed there. So running a linter that ensured an overall consistent README.md format would ensure no merge conflicts happen owing to matrix padding.

My preference would be a README.md.tpl doc that is authoritative to generate the README.md + a config file, see https://docs.gomplate.ca/usage/ for example.

[k8s-ci-robot]

PR needs rebase.

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.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale