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

Define minimum supported period for 1.0 #10004

Closed
mx-psi opened this issue Apr 19, 2024 · 2 comments · Fixed by #11001
Closed

Define minimum supported period for 1.0 #10004

mx-psi opened this issue Apr 19, 2024 · 2 comments · Fixed by #11001
Assignees
Labels
area:documentation help wanted Good issue for contributors to OpenTelemetry Service to pick up

Comments

@mx-psi
Copy link
Member

mx-psi commented Apr 19, 2024

On the [GA roadmap] we stated as a requirement for 1.0 that

A minimum support period for 1.0 is documented, similarly to API and SDK stability guarantees.

We likely want to differentiate between Go API guarantees vs behavior guarantees and have the guarantees be per component

@mx-psi
Copy link
Member Author

mx-psi commented May 20, 2024

Thinking about this, I feel like there are two kinds of APIs here to consider that we may want to have different support periods: those that directly concern component creation (pdata, component, confmap...) and those that are only of concern to distro/distro-like use cases (otelcol, service...).

mx-psi added a commit that referenced this issue Jul 9, 2024
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number if applicable -->

Reworks 'Target audiences' section to:

1. Reflect the three audiences we have today, distinguishing between
component developers and Collector library users
2. Reflect that we encourage end-users to use the OpenTelemetry
Collector Builder and that builder compatibility should be a concern
when thinking about binary end-users

#### Link to tracking issue

Relates to #10004

---------

Co-authored-by: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com>
Co-authored-by: Yang Song <songy23@users.noreply.github.com>
@mx-psi mx-psi added help wanted Good issue for contributors to OpenTelemetry Service to pick up area:documentation labels Jul 17, 2024
@mx-psi mx-psi added this to the Collector v1 distro milestone Jul 23, 2024
@tiffany76
Copy link
Contributor

During the Comms SIG meeting on August 5, we discussed where this content should live: website or repo. The initial preference was for option 1, but we've asked for additional comments.

Options:

  1. Mention the existence of support policies on the website but link to policy details in the repos. This placement serves two purposes:
  • It grants the Collector SIG easy access to the policy content, especially if it's going to change.
  • The users most concerned about the API policies are component developers and library users, not end users (the website's intended audience).
    • But that leaves the question of what to do with behavior guarantees per component, which are most useful to end users.
  1. Divide the policies so API support periods are housed in the repos and component guarantees are placed on the website.
  • This option aligns the intended audience of the doc with the user most in need of the policy, but it could complicate the maintenance of the policies.
  1. Place all policies with their full content on the website.
  • End users are happy, but developers might not be.

Comms SIG would also like to hear what the Collector SIG thinks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation help wanted Good issue for contributors to OpenTelemetry Service to pick up
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants