-
Notifications
You must be signed in to change notification settings - Fork 282
[events] refine general event semantics documentation #3030
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?
Conversation
|
I do not think this needs a changelog. Feel free to remove the label if you disagree. |
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.
Pull Request Overview
This PR refines the documentation for OpenTelemetry Events to improve clarity and better align with semantic conventions standards. The changes reorganize and consolidate event requirements while maintaining technical accuracy.
- Consolidated event definition requirements into a clearer structure
- Improved the phrasing of event semantics to be more concise and consistent with RFC 2119 keywords
- Enhanced guidance for external event compatibility scenarios
Clarified guidelines on event details and body usage.
Co-authored-by: Liudmila Molkova <[email protected]>
lmolkova
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.
didn't realize I had pending comments, posing now
Removed redundant phrases and clarified semantic conventions for events.
Towards stabilization of https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md
Fixes #1651
Changes
This PR refines the documentation for general event semantics to improve clarity and structure.
Documentation improvements
Requirement level clarifications
Technical changes
Rationale
The changes improve developer experience by: