Skip to content

Add upgrading and version management documentation - #3695

Merged
carlosalberto merged 7 commits into
open-telemetry:mainfrom
tedsuo:version
Oct 10, 2023
Merged

carlosalberto merged 7 commits into
open-telemetry:mainfrom
tedsuo:version

Conversation

@tedsuo

@tedsuo tedsuo commented Sep 18, 2023

Copy link
Copy Markdown
Contributor

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
Comment thread specification/upgrading.md Resolved

@tigrannajaryan tigrannajaryan left a comment

Copy link
Copy Markdown
Member

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.

Comment thread specification/upgrading.md Resolved
Comment thread specification/upgrading.md Resolved
Comment thread specification/upgrading.md Resolved
Comment thread specification/upgrading.md Resolved
Comment thread specification/upgrading.md Resolved
Comment thread specification/upgrading.md Resolved
@tedsuo tedsuo assigned tigrannajaryan and unassigned bogdandrutu Sep 19, 2023
marcalff

This comment was marked as duplicate.

Comment thread specification/upgrading.md Resolved
@carlosalberto

Copy link
Copy Markdown
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
Copy Markdown
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.

Comment thread specification/upgrading.md Resolved
Comment thread specification/upgrading.md Resolved
Comment thread specification/upgrading.md Resolved
Comment thread specification/upgrading.md Resolved
@github-actions

github-actions Bot commented Oct 4, 2023

Copy link
Copy Markdown

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
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