Clean up and de-dup the docs repository #178
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
No big changes here, just housecleaning
This was referenced Dec 25, 2016
yurishkuro
reviewed
Dec 25, 2016
| A per-platform OpenTracing API library (e.g., [opentracing-go](https://github.com/opentracing/opentracing-go), [opentracing-java](https://github.com/opentracing/opentracing-java), etc; not OpenTracing `Tracer` *implementations*) must provide a no-op Tracer as part of their interface. The no-op Tracer implementation must not crash and should have no side-effects, including baggage propagation. The Tracer implementation must provide a no-op Span implementation as well; in this way, the instrumentation code that relies on Span instances returned by the Tracer does not need to change to accommodate the possibility of no-op implementations. The no-op Tracer's Inject method should always succeed, and Extract should always behave as if no `SpanContext` could be found in the carrier. | ||
|
|
||
| The per-platform OpenTracing API libraries *may* provide support for configuring (Go: `InitGlobalTracer()`, py: `opentracing.tracer = myTracer`) and retrieving (Go: `GlobalTracer()`, py: `opentracing.tracer`) a global/singleton Tracer instance. If a global Tracer is supported, the default must be the no-op Tracer. | ||
| Both are versioned and the github repository is tagged according to the rules described at [the top of the specification document](https://github.com/opentracing/specification/blob/master/specification.md#versioning-policy). |
There was a problem hiding this comment.
maybe s/at the top of the specification document/by the versioning policy/
There was a problem hiding this comment.
good idea, yep... I didn't have the link there when I wrote the original copy.
| @@ -6,30 +6,12 @@ | |||
|
|
|||
| ## Jaeger | |||
|
|
|||
| [Jaeger \ˈyā-gər\](http://uber.github.io/jaeger) is Uber's distributed tracing system, built with OpenTracing support from inception. Jaeger includes OpenTracing client libraries in several languages: [Java](https://github.com/uber/jaeger-client-java), [Go](https://github.com/uber/jaeger-client-go), [Python](https://github.com/uber/jaeger-client-python), and [Node.js](https://github.com/uber/jaeger-client-node). | |||
| [Jaeger \ˈyā-gər\ˈ](http://uber.github.io/jaeger) is Uber's distributed tracing system, built with OpenTracing support from inception. Jaeger includes OpenTracing client libraries in several languages: [Java](https://github.com/uber/jaeger-client-java), [Go](https://github.com/uber/jaeger-client-go), [Python](https://github.com/uber/jaeger-client-python), and [Node.js](https://github.com/uber/jaeger-client-node). | |||
There was a problem hiding this comment.
why the second '? The first one denotes the accented syllable.
There was a problem hiding this comment.
ah -- I was fixing the fact that there was an orphan \ character by guessing what was supposed to be escaped :) Removed.
yurishkuro
reviewed
Dec 27, 2016
| @@ -6,30 +6,12 @@ | |||
|
|
|||
| ## Jaeger | |||
|
|
|||
| [Jaeger \ˈyā-gər\](http://uber.github.io/jaeger) is Uber's distributed tracing system, built with OpenTracing support from inception. Jaeger includes OpenTracing client libraries in several languages: [Java](https://github.com/uber/jaeger-client-java), [Go](https://github.com/uber/jaeger-client-go), [Python](https://github.com/uber/jaeger-client-python), and [Node.js](https://github.com/uber/jaeger-client-node). | |||
| [Jaeger \ˈyā-gər](http://uber.github.io/jaeger) is Uber's distributed tracing system, built with OpenTracing support from inception. Jaeger includes OpenTracing client libraries in several languages: [Java](https://github.com/uber/jaeger-client-java), [Go](https://github.com/uber/jaeger-client-go), [Python](https://github.com/uber/jaeger-client-python), and [Node.js](https://github.com/uber/jaeger-client-node). | |||
There was a problem hiding this comment.
@yurishkuro ah :)
Ok, look again. My local .md syntax highlighter is more pedantic than jekyll about the escaping, it seems. What I have in the latest revision pleases both the highlighter and jekyll.
reimertz
pushed a commit
to reimertz/opentracing.io
that referenced
this pull request
Mar 22, 2017
* Make "concepts and terminology" a ptr to the spec * Clean up several pages No big changes here, just housecleaning * Replace most of the data-conventions.md with a ptr * Address PR comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Larger changes:
Smaller changes: basically just copy-editing of other files that I had time for.