Skip to content
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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mx-psi
Copy link
Member

@mx-psi mx-psi commented Dec 12, 2024

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

…or components based on their stability level
@mx-psi mx-psi requested a review from a team as a code owner December 12, 2024 13:09
@mx-psi mx-psi requested a review from bogdandrutu December 12, 2024 13:09
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.59%. Comparing base (8ac40a0) to head (5fdfafe).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

Copy link
Member

@julianocosta89 julianocosta89 left a 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.

@mx-psi
Copy link
Member Author

mx-psi commented Dec 13, 2024

One thing to point out. We do not mention that this documentation needs to be on opentelemetry.io.

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

@julianocosta89
Copy link
Member

One thing to point out. We do not mention that this documentation needs to be on opentelemetry.io.

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!
I also think having 2 repos is a pain. We are currently struggling with that in the Demo repo, and I feel that this would also impact the documentation of the Collector components.

Ideally the component codeowners would create a markdown or something, and that would be mapped properly in the docs.
Let's see what the doc team says. I'll open an issue there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document documentation requirements for stable components
2 participants