Skip to content

Commit

Permalink
[editorial] Add missing READMEs to section (#2559)
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin authored May 20, 2022
1 parent 066cbfc commit 0c793b4
Show file tree
Hide file tree
Showing 14 changed files with 24 additions and 14 deletions.
2 changes: 1 addition & 1 deletion specification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- [Package/Library Layout](library-layout.md)
- [General error handling guidelines](error-handling.md)
- API Specification
- [Context](context/context.md)
- [Context](context/README.md)
- [Propagators](context/api-propagators.md)
- [Baggage](baggage/api.md)
- [Tracing](trace/api.md)
Expand Down
1 change: 1 addition & 0 deletions specification/baggage/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Baggage
6 changes: 3 additions & 3 deletions specification/baggage/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ REQUIRED parameters:
## Context Interaction

This section defines all operations within the Baggage API that interact with
the [`Context`](../context/context.md).
the [`Context`](../context/README.md).

If an implementation of this API does not operate directly on the `Context`, it
MUST provide the following functionality to interact with a `Context` instance:
Expand All @@ -110,11 +110,11 @@ MUST provide the following functionality to interact with a `Context` instance:
- Insert the `Baggage` to a `Context` instance

The functionality listed above is necessary because API users SHOULD NOT have
access to the [Context Key](../context/context.md#create-a-key) used by the
access to the [Context Key](../context/README.md#create-a-key) used by the
Baggage API implementation.

If the language has support for implicitly propagated `Context` (see
[here](../context/context.md#optional-global-operations)), the API SHOULD also
[here](../context/README.md#optional-global-operations)), the API SHOULD also
provide the following functionality:

- Get the currently active `Baggage` from the implicit context. This is
Expand Down
3 changes: 3 additions & 0 deletions specification/common/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!---
aliases: [/docs/reference/specification/common/common]
--->
# Common specification concepts

**Status**: [Stable, Feature-freeze](../document-status.md)
Expand Down
1 change: 1 addition & 0 deletions specification/compatibility/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Compatibility
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!---
aliases: [/docs/reference/specification/context/context]
--->
# Context

**Status**: [Stable, Feature-freeze](../document-status.md).
Expand Down
2 changes: 1 addition & 1 deletion specification/metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ important to understand the goals of OpenTelemetry’s metrics effort:

* **Being able to connect metrics to other signals**. For example, metrics and
traces can be correlated via exemplars, and metrics attributes can be enriched
via [Baggage](../baggage/api.md) and [Context](../context/context.md).
via [Baggage](../baggage/api.md) and [Context](../context/README.md).
Additionally, [Resource](../resource/sdk.md) can be applied to
[logs](../overview.md#log-signal)/[metrics](../overview.md#metric-signal)/[traces](../overview.md#tracing-signal)
in a consistent way.
Expand Down
4 changes: 2 additions & 2 deletions specification/metrics/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,15 +298,15 @@ asynchronous:
inline with application/business processing logic. For example, an HTTP client
could use a Counter to record the number of bytes it has received.
[Measurements](#measurement) recorded by synchronous instruments can be
associated with the [Context](../context/context.md).
associated with the [Context](../context/README.md).

* Asynchronous instruments (e.g. [Asynchronous Gauge](#asynchronous-gauge)) give
the user a way to register callback function, and the callback function will
be invoked only on demand (see SDK [collection](sdk.md#collect) for reference). For example, a piece of embedded software
could use an asynchronous gauge to collect the temperature from a sensor every
15 seconds, which means the callback function will only be invoked every 15
seconds. [Measurements](#measurement) recorded by asynchronous instruments
cannot be associated with the [Context](../context/context.md).
cannot be associated with the [Context](../context/README.md).

Please note that the term *synchronous* and *asynchronous* have nothing to do
with the [asynchronous
Expand Down
4 changes: 2 additions & 2 deletions specification/metrics/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,7 @@ This interface SHOULD have access to:

- The `value` of the measurement.
- The complete set of `Attributes` of the measurement.
- The [Context](../context/context.md) of the measurement, which covers the
- The [Context](../context/README.md) of the measurement, which covers the
[Baggage](../baggage/api.md) and the current active
[Span](../trace/api.md#span).
- A `timestamp` that best represents when the measurement was taken.
Expand All @@ -663,7 +663,7 @@ The "offer" method SHOULD accept measurements, including:

- The `value` of the measurement.
- The complete set of `Attributes` of the measurement.
- The [Context](../context/context.md) of the measurement, which covers the
- The [Context](../context/README.md) of the measurement, which covers the
[Baggage](../baggage/api.md) and the current active
[Span](../trace/api.md#span).
- A `timestamp` that best represents when the measurement was taken.
Expand Down
2 changes: 1 addition & 1 deletion specification/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ All of OpenTelemetry cross-cutting concerns, such as traces and metrics,
share an underlying `Context` mechanism for storing state and
accessing data across the lifespan of a distributed transaction.

See the [Context](context/context.md)
See the [Context](context/README.md)

## Propagators

Expand Down
1 change: 1 addition & 0 deletions specification/resource/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Resource
1 change: 1 addition & 0 deletions specification/trace/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Trace
6 changes: 3 additions & 3 deletions specification/trace/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ association.
## Context Interaction

This section defines all operations within the Tracing API that interact with the
[`Context`](../context/context.md).
[`Context`](../context/README.md).

The API MUST provide the following functionality to interact with a `Context`
instance:
Expand All @@ -162,10 +162,10 @@ instance:
- Insert the `Span` to a `Context` instance

The functionality listed above is necessary because API users SHOULD NOT have
access to the [Context Key](../context/context.md#create-a-key) used by the Tracing API implementation.
access to the [Context Key](../context/README.md#create-a-key) used by the Tracing API implementation.

If the language has support for implicitly propagated `Context` (see
[here](../context/context.md#optional-global-operations)), the API SHOULD also provide
[here](../context/README.md#optional-global-operations)), the API SHOULD also provide
the following functionality:

- Get the currently active span from the implicit context. This is equivalent to getting the implicit context, then extracting the `Span` from the context.
Expand Down
2 changes: 1 addition & 1 deletion specification/trace/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ Returns the sampling Decision for a `Span` to be created.

**Required arguments:**

* [`Context`](../context/context.md) with parent `Span`.
* [`Context`](../context/README.md) with parent `Span`.
The Span's SpanContext may be invalid to indicate a root span.
* `TraceId` of the `Span` to be created.
If the parent `SpanContext` contains a valid `TraceId`, they MUST always match.
Expand Down

0 comments on commit 0c793b4

Please sign in to comment.