-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Compatibility updates for v2 in README #6316
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Jonah Kowall <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6316 +/- ##
=======================================
Coverage 96.22% 96.22%
=======================================
Files 356 356
Lines 20454 20454
=======================================
Hits 19681 19681
Misses 585 585
Partials 188 188
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
@@ -67,7 +67,7 @@ For example, any given Jaeger installation at Uber is typically processing sever | |||
|
|||
### Relationship with OpenTelemetry |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, I recently removed this section altogether, moved it to the documentation.
https://www.jaegertracing.io/docs/next-release-v2/#relationship-with-opentelemetry
@@ -124,19 +124,19 @@ of routing the traffic from Zipkin libraries to the Jaeger backend. | |||
|
|||
## 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 elements in Jaeger (or in Jaeger v1 CLI flags) can be deprecated due to usability improvements, new functionality, or changes in our dependencies. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think "configuration option" used in L129 sounds better than "element", perhaps converge to that one for consistency?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changes lgtm
Which problem is this PR solving?
Addresses part of jaegertracing/documentation#117
Description of the changes
Update text to match Jaeger v2
How was this change tested?
Not tested
Checklist