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

Add upgrading and version management documentation #3695

Merged
merged 7 commits into from
Oct 10, 2023

Conversation

tedsuo
Copy link
Contributor

@tedsuo tedsuo commented Sep 18, 2023

Long ago, we defined upgrading procedures for OpenTelemetry, in OTEP 147. However, we never added this language to the specification.

This pull request adds the OTEP to the specification, verbatim, except for an addition at the top which clearly spells out dependency management for application developers, library maintainers, and SDK implementors.

It has been two years, so I am open to changes to this document. Both for clarity, and to conform to how we currently practice upgrading and dependency management.

@tedsuo tedsuo requested review from a team September 18, 2023 21:24
specification/upgrading.md Outdated Show resolved Hide resolved
Copy link
Member

@tigrannajaryan tigrannajaryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with some minor comments.

specification/upgrading.md Outdated Show resolved Hide resolved
specification/upgrading.md Outdated Show resolved Hide resolved
specification/upgrading.md Outdated Show resolved Hide resolved
specification/upgrading.md Outdated Show resolved Hide resolved
specification/upgrading.md Outdated Show resolved Hide resolved
specification/upgrading.md Outdated Show resolved Hide resolved
@tedsuo tedsuo assigned tigrannajaryan and unassigned bogdandrutu Sep 19, 2023
marcalff

This comment was marked as duplicate.

@carlosalberto
Copy link
Contributor

Overall LGTM - although I'm curious around the 1-year deprecation phase, mostly as we haven't, so far, deprecated any Plugin component.

@tigrannajaryan
Copy link
Member

Editorial: any chance to limit the line lengths? Commenting on a specific word/sentence is harder and github diffs are less readable with very long lines.

specification/upgrading.md Outdated Show resolved Hide resolved
specification/upgrading.md Outdated Show resolved Hide resolved
specification/upgrading.md Outdated Show resolved Hide resolved
specification/upgrading.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Oct 4, 2023

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@arminru arminru removed the Stale label Oct 10, 2023
@carlosalberto carlosalberto merged commit 3b02868 into open-telemetry:main Oct 10, 2023
6 checks passed
arminru added a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 10, 2023
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
Long ago, we defined upgrading procedures for OpenTelemetry, in [OTEP
147](https://github.com/open-telemetry/oteps/blob/main/text/0147-upgrade-procedures.md).
However, we never added this language to the specification.

This pull request adds the OTEP to the specification, verbatim, except
for an addition at the top which clearly spells out dependency
management for application developers, library maintainers, and SDK
implementors.

It has been two years, so I am open to changes to this document. Both
for clarity, and to conform to how we currently practice upgrading and
dependency management.
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.

10 participants