Add Mkdocs Spellcheck Linter

[danehans]

Several issues/PRs have been filed due to misspellings in docs site content. A spellcheck linter should be added to mkdocs. See https://pawamoy.github.io/mkdocs-spellcheck/ as a potential candidate and implementation details.

[danehans]

@robscott does the gateway api repo use any linters for mkdocs content?

[robscott]

Sadly not, but we probably should try that out.

[danehans]

/assign @artberger

[k8s-ci-robot]

@danehans: GitHub didn't allow me to assign the following users: artberger.

Note that only kubernetes-sigs members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @artberger

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-sigs/prow repository.

[artberger]

Here's a link to my fork’s changes of what the mkdocs-spellcheck integration could look like.

There is also another linter called Vale that I use for other doc projects. It is a little different than mkdocs, as it would be a GitHub Action that could run per-PR instead of in the build process. I could also set that up in my fork if you'd be interested in seeing what that looks like.

[danehans]

Thanks @artberger for taking on this issue. I lean towards mkdocs since it provides consistency with the Gateway API project.

[k8s-triage-robot]

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

This bot triages un-triaged issues 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 issue is closed

You can:

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

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

/lifecycle stale

[artberger]

/remove-lifecycle stale