cert-manager / website

Source code for the cert-manager.io website, including project documentation
https://cert-manager.io
Apache License 2.0
53 stars 330 forks source link

Spelling errors are unclear in pull request CI results and spell checker is unmaintained #802

Open wallrj opened 2 years ago

wallrj commented 2 years ago

When the spell-checker is run from CI for a PR and fails, the results are not syntax highlighted so it's difficult to know which word caused the failure. For example:

image

https://prow.build-infra.jetstack.net/view/gs/jetstack-logs/pr-logs/pull/cert-manager_website/797/pull-cert-manager-website-verify/1483400121444995072

We use https://github.com/lukeapage/node-markdown-spellcheck which seems to be unmaintained. Its dependencies are out-of-data and causing false-alarms from Dependabot

image https://github.com/cert-manager/website/security/dependabot/package-lock.json/marked/open

Perhaps we should use a different spell checker. For example:

/bug

jsoref commented 2 years ago

Well, you could use https://github.com/marketplace/actions/check-spelling 😺