search

jaegertracing / documentation

Documentation/website for the Jaeger Distributed Tracing project.
https://jaegertracing.io/
Apache License 2.0
65 stars 158 forks source link

Fix typo in OpenTelemetry #700

Closed MA3CIN closed 3 months ago

MA3CIN commented 4 months ago

Which problem is this PR solving?

a typo in troubleshooting.MD

Surprisingly, the spellcheck didn't pick this one up, probably due to the Markdown hashtags being interpreted as a comment. image

Checklist

netlify[bot] commented 4 months ago

Deploy Preview for romantic-neumann-1959d7 ready!

Name Link
Latest commit 7c1367e6e144c70e33cbf9da8344df4f5b9cef7e
Latest deploy log https://app.netlify.com/sites/romantic-neumann-1959d7/deploys/663c88757503ff0008458181
Deploy Preview https://deploy-preview-700--romantic-neumann-1959d7.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

MA3CIN commented 3 months ago

@yurishkuro Yes, you are right. Some of these are an easy fix, but the rest... I'm not sure if these are even words in English...? boths? bohara? afzal? ansh? Most of these are names. I guess if a word is neither a name nor an established term in Software, i'll purge it.

yurishkuro commented 3 months ago

boths? bohara? afzal? ansh?

boths sounds like a typo, the others are people's names (interns from the mentorship program / page). I don't know what a good way to handle this, we cannot just remove them from the dictionary, the linter will start failing.

MA3CIN commented 3 months ago

@yurishkuro Alright, then i propose the following: Accept and close this PR, because the changes here are indifferent to the linter and spellchecker I'll open a separate PR fixing the Dictionary file, on which we can review and discuss the proposed changes

yurishkuro commented 3 months ago

Sure, but to complete this PR I want to make sure this misspelled work is not in the dictionary.

MA3CIN commented 3 months ago

@yurishkuro I see - all three (opentelemetry, opentracing, openzipkin) are spelled correctly in the dictionary. I checked that initially, but didn't comment that I did. The spellechecker must have ignored Markdown hashtags, and interpreted them as a comment.

yurishkuro commented 3 months ago

https://github.com/jaegertracing/documentation/issues/701