Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit 78c8422

Browse files
author
Bogdan Drutu
authored
Update links, add minimal README to tags. (#80)
1 parent 93a4f33 commit 78c8422

4 files changed

Lines changed: 19 additions & 16 deletions

File tree

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This is customer's application/binary.
5151

5252
### Namespace and Package
5353

54-
* For details about the library package names structure see [Namespace and Package][NamespaceAndPackage].
54+
* For details about the library package names structure see [Namespace and Package](NamespaceAndPackage.md).
5555

5656
### Components
5757

@@ -99,8 +99,8 @@ The key elements of the API can be broken down as:
9999

100100
##### Links
101101

102-
* Trace API is [here][TraceAPI].
103-
* Data model is defined at the [Trace Data Model][TraceDataModel] document.
102+
* Details about Trace package can be found [here](trace/README.md).
103+
* Data model is defined at the [Trace Data Model][TraceDataModel].
104104

105105
#### Tags
106106

@@ -121,7 +121,7 @@ The key elements of the Tags component are:
121121

122122
##### Links
123123

124-
* TODO: Add links to API definition and data model.
124+
* Details about Tags package can be found [here](tags/README.md).
125125

126126
#### Stats
127127

@@ -146,24 +146,21 @@ The key elements the API MUST provide are:
146146

147147
##### Links
148148

149-
* Stats API is [here][StatsAPI].
150-
* TODO: Add links to API definition and data model.
149+
* Details about Stats package can be found [here](stats/README.md).
150+
* Data model is defined at the [Stats Data Model][StatsDataModel].
151151

152152
### Supported propagation formats
153153

154154
* Library MUST support the [TraceContext][TraceContextSpecs] format for Trace and Tags components.
155-
* Binary encoding is defined at the [BinaryEncoding][BinaryEncoding] document.
155+
* Binary encoding is defined at the [BinaryEncoding](encodings/BinaryEncoding.md) document.
156156

157157
[EcosystemLayers]: /drawings/EcosystemLayers.png "Ecosystem Layer"
158158
[DapperPaper]: https://research.google.com/pubs/pub36356.html
159159
[goContext]: https://golang.org/pkg/context
160160
[gRPCContext]: https://github.com/grpc/grpc-java/blob/master/context/src/main/java/io/grpc/Context.java
161161
[LibraryComponents]: /drawings/LibraryComponents.png "OpenCensus Library Components"
162-
[NamespaceAndPackage]: https://github.com/census-instrumentation/opencensus-specs/blob/master/NamespaceAndPackage.md
163162
[RFC2119]: https://www.ietf.org/rfc/rfc2119.txt
164-
[TraceAPI]: https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/README.md
165-
[StatsAPI]: https://github.com/census-instrumentation/opencensus-specs/blob/master/stats/README.md
163+
[StatsDataModel]: https://github.com/census-instrumentation/opencensus-proto/blob/master/opencensus/proto/stats/stats.proto
166164
[TraceContextSpecs]: https://github.com/TraceContext/tracecontext-spec
167165
[TraceDataModel]: https://github.com/census-instrumentation/opencensus-proto/blob/master/opencensus/proto/trace/trace.proto
168-
[BinaryEncoding]: https://github.com/census-instrumentation/opencensus-specs/blob/master/encodings/BinaryEncoding.md
169166
[activity]: https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md

stats/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# OpenCensus Library Stats API
2-
This documentation serves to document the "look and feel" of the open source stats API's. It
1+
# OpenCensus Library Stats Package
2+
This documentation serves to document the "look and feel" of the open source stats package. It
33
describes the key types and the overall behavior.
44

55
## Overview

tags/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# OpenCensus Library Tags Package
2+
This documentation serves to document the "look and feel" of the open source tags package. It
3+
describes the key types and the overall behavior.
4+
5+
## Main APIs
6+
* [TagContext](TagContext.md)

trace/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# OpenCensus Library Trace
2-
This document serves to document the "look and feel" of the open source trace API's. It describes
3-
the key types (classes, structures, etc.) and functions (methods, etc.).
1+
# OpenCensus Library Trace Package
2+
This documentation serves to document the "look and feel" of the open source tags package. It
3+
describes the key types and the overall behavior.
44

55
## Main APIs
66
* [Span](Span.md)

0 commit comments

Comments
 (0)