ci(docs): add markdown linters and editorconfig

[mloiseleur]

Description

It adds:

1. a markdown linter on format
2. pre-commit hooks with this linter
3. Makefile command and GitHub action on this linter
4. default editorconfig

[k8s-ci-robot]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[ivankatliarchuk]

Maybe we should add something like .pre-commit-hooks ? As having same only on CI, will make it difficult for contributors, as it should be a way to fmt things locally too

Example autoscaler https://github.com/kubernetes/autoscaler/blob/master/.pre-commit-config.yaml

There is as well editorconfig, supported by all the editors by default https://editorconfig.org/

This things helps to organise formatting related issues.

pre-commit

• kubernetes-sigs https://github.com/search?q=org%3Akubernetes-sigs%20github.com%2Fpre-commit&type=code
• kubernetes https://github.com/search?q=org%3Akubernetes+github.com%2Fpre-commit&type=code

Editorconfig

• kubernetes-sigs https://github.com/search?q=org%3Akubernetes-sigs+%23+EditorConfig&type=code
• kubernetes https://github.com/search?q=org%3Akubernetes+indent_size&type=code

the tools are vetted to my understanding

[mloiseleur]

/label tide/merge-method-squash

[ivankatliarchuk]

/lgtm

[mloiseleur]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivankatliarchuk, mloiseleur

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

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

[stevehipwell]

@mloiseleur I think some more discussion about the EditorConfig file is required?

• You shouldn't set root = true in a workspace EditorConfig configuration as it should fall back to the user settings
• Optional values can be omitted to use the default or the user defined config (see above)
• It looks like you're missing the Go section ([{go.mod,go.sum,*.go}] which is required as Go tooling expects (and demands tabs) like Make (use indent_size=2 to change the view)

[stevehipwell]

@mloiseleur I've also noticed that you've made some changes to the GH Actions workflows that aren't following best practices.

• Removed the top level permissions
  • These should always be set to a read-only permission (e.g. permissions: read-all)
• Referenced actions by tag
  • Actions should be referenced by digest with the tag in a comment

And RE markdownlint markdownlint-cli2 & markdownlint-cli2-action are maintained by the markdownlint creator and should be the prefered options. The action introduced here unnecessarily uses a Dockerfile.