-
Notifications
You must be signed in to change notification settings - Fork 895
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
Mark telemetry schema readme stable. #3221
Mark telemetry schema readme stable. #3221
Conversation
Do we consider this README part of the spec or not? If it's not part of spec, it shouldn't have "Stable" tag. (e.g. similar to https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/README.md) If it is part of the spec, we need to fix the wording (e.g. s/should/SHOULD). |
Good point. I had considered these README to be non-spec. I haven't been reviewing them for requirements we need to implement. |
This is a good question. I would definitely consider some parts to be a spec. For example "How Schemas Work" contains a lot of normative language. Similarly "Schema URL" section is precise and is a spec. As opposed to that "Use Cases" are examples that are not a spec. |
Agreed. Alternatively we can 'extract' such parts and put them into their own document. Fine by me either way. |
So I've updated the normative wording. I think there's a few normative phrases in this document that are crucial to stability and that we've been enforcing:
The other should/musts I found were demonstrative, not normative so I've modified them. PTAL |
Part of unblocking #3219
Changes
Mark the telemetry schema README as stable.
Reasoning: