Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add linter for spelling/typos #2291

Closed
5 tasks
RealAnna opened this issue Oct 18, 2023 · 8 comments · Fixed by #2316
Closed
5 tasks

Add linter for spelling/typos #2291

RealAnna opened this issue Oct 18, 2023 · 8 comments · Fixed by #2316
Assignees
Labels
docs-infrastructure Issues related to the look and feel of the docs good first issue Good for newcomers status: ready-for-refinement Issue is relevant for the next backlog refinment
Milestone

Comments

@RealAnna
Copy link
Contributor

RealAnna commented Oct 18, 2023

In spite of our reviewing efforts some typo often makes it through and gets into our documentation.
This is probably true also for code and other files.
Let's add a spell checker action so that we can detect this before merge 🤕

AC

DoD

  • no more typos in docs
  • new PRs cannot be merged until typos are fixed
@RealAnna RealAnna added good first issue Good for newcomers status: ready-for-refinement Issue is relevant for the next backlog refinment docs-infrastructure Issues related to the look and feel of the docs labels Oct 18, 2023
@mowies
Copy link
Member

mowies commented Oct 18, 2023

I think we should not only execute the spell checker for docs but maybe also for go files and yaml files, maybe even all files.
We have lots of spots where docs comments are in the code, or comments in yaml examples, helm values with docs etc.

@mowies mowies added this to the 0.9 milestone Oct 18, 2023
@sambhavgupta0705
Copy link
Member

Can I try working on this issue??

@mowies
Copy link
Member

mowies commented Oct 23, 2023

sure thing @sambhavgupta0705 ! I assigned the issue to you :)
If you need any help, just @ us here

@sambhavgupta0705
Copy link
Member

thanks @mowies
I am considering to use this github action https://github.com/check-spelling/check-spelling

@mowies
Copy link
Member

mowies commented Oct 23, 2023

we double checked your suggestion. the action from the issue description is actually far more widely used, so please use github.com/marketplace/actions/typos-action

@mowies
Copy link
Member

mowies commented Oct 25, 2023

Sorry @sambhavgupta0705, but I just checked out the typos-action in more detail and it doesn't really do what we require. There, we would need to define our own typo corrections manually which is not something we wanna do.
So I think your initial suggestion of using check-spelling was actually much better. If you have the time, please change to that action.
There a good example workflow here.

We only want the minimal setup for now that is decsribed here. Although the job doesn't need to run on push, just on pull_request_target since we only wanna run on PRs and not on normal branch pushes e.g. to main branch.

@mowies
Copy link
Member

mowies commented Oct 25, 2023

If you need any help, or if this is too much hassle for you, please just tell me then, I'll help out or take over.

@sambhavgupta0705
Copy link
Member

@mowies yes I will look into this and make the essential changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-infrastructure Issues related to the look and feel of the docs good first issue Good for newcomers status: ready-for-refinement Issue is relevant for the next backlog refinment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants