aws / karpenter-provider-aws

Karpenter is a Kubernetes Node Autoscaler built for flexibility, performance, and simplicity.
https://karpenter.sh
Apache License 2.0
6.63k stars 924 forks source link

Add spell checking validation to Docs CI #3488

Open jonathan-innis opened 1 year ago

jonathan-innis commented 1 year ago

Tell us about your request

There are currently a few typos in our docs that are caught by users who are reading through the docs more granularly. Ideally, we should have automation that should catch these typos and prevent the PRs from merging.

Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard?

N/A

Are you currently working around this issue?

N/A

Additional Context

No response

Attachments

No response

Community Note

njtran commented 1 year ago

We used to have a spell checker that we ended up removing later https://github.com/aws/karpenter/pull/1057. Maybe instead of doing a github action, we can try and add it in make presubmit?

jonathan-innis commented 1 year ago

Yeah, I think that would be quite a bit more flexible, since devs could run it locally. There is supposedly a spell-checker that runs against our code, but I also haven't seen that catch everything and/or be very effective

jonathan-innis commented 1 year ago

Comments like the ones present in #3757 are good examples of why it would be good to automate this behavior so that a reviewer's time isn't spent catching spelling/grammar errors that are easily made when making changes to docs.