-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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][docs/component-stability.md] Add documentation requirements for components based on their stability level #11871
base: main
Are you sure you want to change the base?
Conversation
…or components based on their stability level
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #11871 +/- ##
=======================================
Coverage 91.59% 91.59%
=======================================
Files 449 449
Lines 23761 23761
=======================================
Hits 21763 21763
Misses 1623 1623
Partials 375 375 ☔ View full report in Codecov by Sentry. |
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.
I like that!
One thing to point out. We do not mention that this documentation needs to be on opentelemetry.io.
Did I assume this correctly?
To me, the official OTel docs is where all documentation should be, and not under the component repo.
I think the documentation should eventually be mirrored on opentelemetry(.)io but I would really want the control over it to be in the hands of the Collector SIG. If it's in another repository that's a huge barrier to people updating the docs. Can you file an issue on the opentelemetry(.)io tracker and ping me there? We can discuss it with them and see how to go about this |
Awesome! Ideally the component codeowners would create a markdown or something, and that would be mapped properly in the docs. |
Description
Adds requirements for documentation for different stability levels.
I expect many of these will be done through automation over time :)
Link to tracking issue
Fixes #11852