From 5b1c76b7885e047ad3924455f27a31f35fd32b50 Mon Sep 17 00:00:00 2001 From: Jonah Kowall Date: Mon, 23 Dec 2024 16:06:11 -0500 Subject: [PATCH] Compatibility updates for v2 in README (#6316) ## Which problem is this PR solving? Addresses part of https://github.com/jaegertracing/documentation/issues/117 ## Description of the changes Update text to match Jaeger v2 ## How was this change tested? Not tested ## Checklist - [X] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [X] I have signed all commits --------- Signed-off-by: Jonah Kowall --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 783edaeb599..b843db4fbf3 100644 --- a/README.md +++ b/README.md @@ -47,19 +47,19 @@ Jaeger is an open source project with open governance. We welcome contributions ## Version Compatibility Guarantees -Occasionally, CLI flags can be deprecated due to, for example, usability improvements or new functionality. +Since Jaeger uses many components from the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector/) we try to maintain configuration compatibility between Jaeger releases. Occasionally, configuration options in Jaeger (or in Jaeger v1 CLI flags) can be deprecated due to usability improvements, new functionality, or changes in our dependencies. In such situations, developers introducing the deprecation are required to follow [these guidelines](./CONTRIBUTING.md#deprecating-cli-flags). -In short, for a deprecated CLI flag, you should expect to see the following message in the `--help` documentation: +In short, for a deprecated configuration option, you should expect to see the following message in the documentation or release notes: ``` (deprecated, will be removed after yyyy-mm-dd or in release vX.Y.Z, whichever is later) ``` A grace period of at least **3 months** or **two minor version bumps** (whichever is later) from the first release -containing the deprecation notice will be provided before the deprecated CLI flag _can_ be deleted. +containing the deprecation notice will be provided before the deprecated configuration option _can_ be deleted. -For example, consider a scenario where v1.28.0 is released on 01-Jun-2021 containing a deprecation notice for a CLI flag. -This flag will remain in a deprecated state until the later of 01-Sep-2021 or v1.30.0 where it _can_ be removed on or after either of those events. +For example, consider a scenario where v2.0.0 is released on 01-Sep-2024 containing a deprecation notice for a configuration option. +This configuration option will remain in a deprecated state until the later of 01-Dec-2024 or v2.2.0 where it _can_ be removed on or after either of those events. It may remain deprecated for longer than the aforementioned grace period. ## Go Version Compatibility Guarantees