-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Copy edit custom component documentation #8547
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
base: main
Are you sure you want to change the base?
Copy edit custom component documentation #8547
Conversation
tiffany76
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @onyeepeace! Thanks for putting this PR together. I've completed a partial review and made several suggestions to take the copy edits a little further. These pages needed some extra attention.
I will come back and review the last file very soon. It's quite large! In the meantime, feel free to address the comments I've already made. Thanks again!
tiffany76
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great for a first pass of these very long pages! Thanks so much, @onyeepeace.
To keep things moving, I'm going to commit my suggestions so we can see where the PR stands.
Signed-off-by: Tiffany Hrabusa <[email protected]>
Signed-off-by: Tiffany Hrabusa <[email protected]>
Signed-off-by: Tiffany Hrabusa <[email protected]>
Signed-off-by: Tiffany Hrabusa <[email protected]>
|
@open-telemetry/collector-approvers - I know this is a long one. I tried to make sure the meaning wasn't changed anywhere. The Build a Receiver page will need further edits, but it was too much to do in this PR. If someone wants to take a look, that'd be great. Thanks! |
contribution guidelines,
including the First-time contributing? note.
the
Generative AI Contribution Policy.
Fixes 8362.
The PR enhances the OpenTelemetry Collector documentation by restructuring sentences for improved clarity, refining explanations of core concepts, and correcting grammatical errors.
These changes make the tutorial more accessible for implementing OpenTelemetry Collector components, reducing onboarding friction and potential misinterpretation of the API.
No functional code changes are included.