docs: document backwards compatibility #140
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Document backwards compatability based on the grafana/agent backwards compatability [RFC]. Some changes have been made: * Major release burnout and LTS suppor for previous major releases is not mentioned. * "The scope of backwards compatability" has been removed from the backwards compatability list, as it is needlessly verbose and we may have forgotten an obvious exception. * The exceptions "undocumented behavior," "tagged as exempt," "other telemetry data," and "non-versioned network APIs" have been integrated elsewhere in the doc to keep the list of exceptions shorter. Despite the changes above, the intent is still the same: we strive wherever possible to maintain compatability for users between minor and patch releases. [RFC]: https://github.com/grafana/agent/blob/main/docs/rfcs/0008-backwards-compatibility.md
ptodev
approved these changes
Apr 8, 2024
Co-authored-by: Paulin Todev <[email protected]>
There was a problem hiding this comment.
Still a few cases of passive voice, but it's OK.
Can we change the filename to backward-compatibility.md (US English spelling style).
Location in the TOC... I'd like to see this included in the Introduction section vs out in the doc root (where it is now). This will group it with the release cadence and supported platforms topics
clayton-cornell
added
the
type/docs
Co-authored-by: Clayton Cornell <[email protected]>
clayton-cornell
approved these changes
Apr 8, 2024
github-actions bot
pushed a commit
that referenced
this pull request
Apr 8, 2024
Document backwards compatability based on the grafana/agent backwards compatability [RFC]. Some changes have been made: * Major release burnout and LTS suppor for previous major releases is not mentioned. * "The scope of backwards compatability" has been removed from the backwards compatability list, as it is needlessly verbose and we may have forgotten an obvious exception. * The exceptions "undocumented behavior," "tagged as exempt," "other telemetry data," and "non-versioned network APIs" have been integrated elsewhere in the doc to keep the list of exceptions shorter. Despite the changes above, the intent is still the same: we strive wherever possible to maintain compatability for users between minor and patch releases. [RFC]: https://github.com/grafana/agent/blob/main/docs/rfcs/0008-backwards-compatibility.md Co-authored-by: Paulin Todev <[email protected]> Co-authored-by: Clayton Cornell <[email protected]> (cherry picked from commit 38fd764)
rfratto
added a commit
that referenced
this pull request
Apr 8, 2024
Document backwards compatability based on the grafana/agent backwards compatability [RFC]. Some changes have been made: * Major release burnout and LTS suppor for previous major releases is not mentioned. * "The scope of backwards compatability" has been removed from the backwards compatability list, as it is needlessly verbose and we may have forgotten an obvious exception. * The exceptions "undocumented behavior," "tagged as exempt," "other telemetry data," and "non-versioned network APIs" have been integrated elsewhere in the doc to keep the list of exceptions shorter. Despite the changes above, the intent is still the same: we strive wherever possible to maintain compatability for users between minor and patch releases. [RFC]: https://github.com/grafana/agent/blob/main/docs/rfcs/0008-backwards-compatibility.md (cherry picked from commit 38fd764) Co-authored-by: Robert Fratto <[email protected]> Co-authored-by: Paulin Todev <[email protected]> Co-authored-by: Clayton Cornell <[email protected]>
rfratto
added
the
backport-to-agent:no
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document backwards compatability based on the grafana/agent backwards compatability RFC. Some changes have been made:
Mention of major release burnout has been removed. We will continue to try to limit major releases to once per calendar year, but I'm not sure it's worth documenting.
LTS support for previous major releases has been removed. The RFC was less formal, and it's not clear how we'll continue to support v1 as v2 gets released. That sounds more like a problem for when we release v2 :)
"The scope of backwards compatibility" has been removed from the backwards compatability list, as it is needlessly verbose and we may have forgotten an obvious exception.
The exceptions "undocumented behavior," "tagged as exempt," "other telemetry data," and "non-versioned network APIs" have been integrated elsewhere in the doc to keep the list of exceptions shorter.
"Bugs" and "specification errors" have been added to the exception list, as incorrect behavior that is relied on may require a breaking change, and contradictory specification in the documentation may need to be resolved by breaking compatibility.
Despite the changes above, the intent is still the same: we strive wherever possible to maintain compatability for users between minor and patch releases.