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

[chore] investigate spellcheck #9287

Open
codeboten opened this issue Jan 15, 2024 · 4 comments
Open

[chore] investigate spellcheck #9287

codeboten opened this issue Jan 15, 2024 · 4 comments
Assignees
Labels
good first issue Good for newcomers help wanted Good issue for contributors to OpenTelemetry Service to pick up

Comments

@codeboten
Copy link
Contributor

As seen by the changes in #9286, I'm not sure if spellcheck is catching typos in the documentation.

Would be good to ensure we have a tool (maybe the cspell gh action that opentelemetry.io uses?) that catch these

@codeboten codeboten added help wanted Good issue for contributors to OpenTelemetry Service to pick up good first issue Good for newcomers labels Jan 15, 2024
@advaithcurpod
Copy link

Hi @codeboten ,

I am Advaith and new to open source contributions. I would like to take up this issue.
I read all the comments in #9286 and see what the issue is

From my understanding so far, you would like to have something like this as part of the gh action workflow?
https://github.com/open-telemetry/opentelemetry.io/blob/main/.cspell.yml
https://github.com/open-telemetry/opentelemetry.io/blob/main/.github/workflows/check-spelling.yml

Would be great if you could assign me this issue and help me with the next steps :)

Thanks!

@codeboten
Copy link
Contributor Author

@advaithcurpod thanks for jumping in! yes this issue was to investigate whether using the cspell github action would work in the case of this repo, maybe for validating markdown files at least.

I've assigned it to you if you'd like to try addressing it!

@advaithcurpod
Copy link

Thank you so much. I shall start working on it and let you know if I have any questions.

@advaithcurpod
Copy link

Hi @codeboten
I have made a PR. Kindly let me know the feedback on it.
Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Good issue for contributors to OpenTelemetry Service to pick up
Projects
None yet
Development

No branches or pull requests

2 participants