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] Spelling #6009

Closed
wants to merge 108 commits into from
Closed

[chore] Spelling #6009

wants to merge 108 commits into from

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Jan 21, 2025

This PR corrects misspellings identified by the check-spelling action

The misspellings have been reported at /~https://github.com/jsoref/opentelemetry.io/actions/runs/12891381190#summary-35943185615

Testing
The action reports that the changes in this PR would make it happy: /~https://github.com/jsoref/opentelemetry.io/actions/runs/12891382105#summary-35943187753

jsoref added 30 commits January 21, 2025 09:25
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
…on docs

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Governance Committee's charter document

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@opentelemetrybot opentelemetrybot requested a review from a team January 21, 2025 17:02
@opentelemetrybot opentelemetrybot requested review from a team and bogdandrutu and removed request for a team January 21, 2025 17:02
If you’d like to see my conversation with Doug in full, you can check out the
video [here](https://www.youtube.com/watch?v=ptYWBF-R1Fc).
If you’d like to see my conversation with Doug in full, there is a
[private video](https://www.youtube.com/watch?v=ptYWBF-R1Fc) -- you’ll have to
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this link is totally useless to the average person which is a problem for something linked from a public blog.

- [Sidecar](https://www.techtarget.com/searchapparchitecture/tip/The-reasons-to-use-or-not-use-sidecars-in-Kubernetes) -
see example
[here](/~https://github.com/open-telemetry/opentelemetry-operator/blob/main/tests/e2e/instrumentation-python/00-install-collector.yaml)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this file is dead in main...

@@ -4,7 +4,7 @@ linkTitle: Humans of OTel
date: 2023-12-22
author: '[Adriana Villela](/~https://github.com/avillela) (Lightstep)'
# prettier-ignore
cSpell:ignore: adiana alex aronoff bogdan boten caramanolis constance dapr drutu jacob juraci kanal kröhling paixāo purvi tyler utopic villela yahn youtube
cSpell:ignore: alex aronoff bogdan boten caramanolis constance dapr drutu jacob juraci kanal kröhling paixāo purvi tyler utopic villela yahn youtube
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since check-spelling wasn't actively honoring cSpell:ignore, I ran across various places where it found items only listed in cSpell:ignore and thus I'm proposing removing them...

@@ -7,7 +7,7 @@ author: >-
issue: 4542
sig: SIG Go
# prettier-ignore
cSpell:ignore: aws Benedetti Fabrizio Ferri gopkg labstack macaron moduled otelaws otelecho otellambda otelmacaron otelmongo otelmux
cSpell:ignore: aws Benedetti Fabrizio Ferri gopkg labstack macaron otelaws otelecho otellambda otelmacaron otelmongo otelmux
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's kinda important to not randomly add misspelled words to a spell checker's ignore list -- it defeats the point of a spell checker...

@reyang
Copy link
Member

reyang commented Jan 21, 2025

@jsoref thanks! Would it be possible to split a big change into smaller PRs?

@jsoref
Copy link
Contributor Author

jsoref commented Jan 21, 2025

Sure. Any preference for how?

@@ -11,7 +11,7 @@ the sky is blue, and it's time to run down the latest updates from the
OpenTelemetry project!

Are you a maintainer with something you’d like featured here? Get in touch with
me [via email](mailto:austin+otel@ap2.io), or on the
[Austin Parker via email](mailto:austin+otel@ap2.io), or on the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem correct ... I think the original intention was "get in touch with me via X or Y" rather than "get in touch with X or Y" ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The goal of this change is to support screen readers that read out lists of links -- they omit any context, so whatever is meaningful about a link needs to be in the link text.

One could make the entire phrase a link as in:

Get in touch with Austin Parker via email

But that felt a bit overkill (it isn't absolutely wrong, and I'm willing to do it, but it's also a bit much).

Comment on lines +56 to +57
- **[EMEA](https://us06web.zoom.us/j/85691064809?pwd=c0VCejh)**: every third
Tuesday of the month at 11AM CET (GMT +1)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is more than spelling, it changed the way how words got structured.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. The rules here just take advantage of the fact that the tool is reading all the content and recognizing common problematic behaviors.

@reyang
Copy link
Member

reyang commented Jan 21, 2025

Sure. Any preference for how?

Consider scoping it down to spelling changes only for now, and having ~10 files touched in each PR.

@reyang
Copy link
Member

reyang commented Jan 23, 2025

Considering this PR is divided into smaller ones, I'll mark it as closed. Thanks @jsoref!

@reyang reyang closed this Jan 23, 2025
@jsoref
Copy link
Contributor Author

jsoref commented Jan 23, 2025

I think a couple of commits will come in one final segment as there were some that were dependent on things in some of these smaller PRs, and I'll probably include one additional for any new typos that sneak in between when this PR was started and when the PRs merge...

@reyang
Copy link
Member

reyang commented Jan 23, 2025

Makes sense. You decide if you want to reuse this PR for the final one or just go with another PR, let me know if you have trouble reopening this PR. Thanks!

@jsoref
Copy link
Contributor Author

jsoref commented Jan 23, 2025

It won't let me reopen it.

I'll just reference this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants