Add a header warning to all OTEPs. (#269)

Since **direct** references to individual OTEPs may exist beyond the OTEL organization, we want to warn users about their deprecation, hence copying the warning from the README (merged) to individual files.
open-telemetry · Nov 26, 2024 · 67dc8ec · 67dc8ec
1 parent 59c5708
commit 67dc8ec
Show file tree

Hide file tree

Showing 69 changed files with 343 additions and 2 deletions.
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -6,5 +6,6 @@
   "ul-style": false,  # MD004
   "line-length": false,  # MD013
   "no-inline-html": false,  # MD033
-  "fenced-code-language": false  # MD040
-}
+  "fenced-code-language": false,  # MD040
+  "first-line-h1": false # MD041
+}
diff --git a/text/0001-telemetry-without-manual-instrumentation.md b/text/0001-telemetry-without-manual-instrumentation.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # (Open) Telemetry Without Manual Instrumentation
 
 _Cross-language requirements for automated approaches to extracting portable telemetry data with zero source code modification._

diff --git a/text/0005-global-init.md b/text/0005-global-init.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Global SDK initialization
 
 **Status**: proposed

diff --git a/text/0007-no-out-of-band-reporting.md b/text/0007-no-out-of-band-reporting.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Remove support to report out-of-band telemetry from the API
 
 ## TL;DR

diff --git a/text/0016-named-tracers.md b/text/0016-named-tracers.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Named Tracers and Meters
 
 _Associate Tracers and Meters with the name and version of the instrumentation library which reports telemetry data by parameterizing the API which the library uses to acquire the Tracer or Meter._

diff --git a/text/0035-opentelemetry-protocol.md b/text/0035-opentelemetry-protocol.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # OpenTelemetry Protocol Specification
 
 **Author**: Tigran Najaryan, Omnition Inc.

diff --git a/text/0038-version-semantic-attribute.md b/text/0038-version-semantic-attribute.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Version Semantic Attribute
 
 Add a standard `version` semantic attribute.

diff --git a/text/0066-separate-context-propagation.md b/text/0066-separate-context-propagation.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Context Propagation: A Layered Approach
 
 * [Motivation](#Motivation)

diff --git a/text/0083-component.md b/text/0083-component.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # InstrumentationLibrary
 
 Introducing the notion of `InstrumentationLibrary` as a first class concept in

diff --git a/text/0099-otlp-http.md b/text/0099-otlp-http.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # OTLP/HTTP: HTTP Transport Extension for OTLP
 
 This is a proposal to add HTTP Transport extension for

diff --git a/text/0110-z-pages.md b/text/0110-z-pages.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # zPages: general direction (#110)
 
 Make zPages a standard OpenTelemetry component.

diff --git a/text/0111-auto-resource-detection.md b/text/0111-auto-resource-detection.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Automatic Resource Detection
 
 Introduce a mechanism to support auto-detection of resources.

diff --git a/text/0119-standard-system-metrics.md b/text/0119-standard-system-metrics.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Standard names for system/runtime metric instruments
 
 This OTEP proposes a set of standard names, labels, and semantic conventions for common system/runtime metric instruments in OpenTelemetry. The instrument names proposed here are common across the supported operating systems and runtime environments. Also included are general semantic conventions for system/runtime metrics including those not specific to a particular OS or runtime.

diff --git a/text/0122-otlp-http-json.md b/text/0122-otlp-http-json.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # OTLP: JSON Encoding for OTLP/HTTP
 
 This is a proposal to add HTTP Transport extension supporting json serialization for

diff --git a/text/0143-versioning-and-stability.md b/text/0143-versioning-and-stability.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Versioning and stability for OpenTelemetry clients
 
 OpenTelemetry is a large project with strict compatibility requirements. This proposal defines the stability guarantees offered by the OpenTelemetry clients, along with a versioning and lifecycle proposal which defines how we meet those requirements.

diff --git a/text/0147-upgrade-procedures.md b/text/0147-upgrade-procedures.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # The OpenTelemetry approach to upgrading
 
 Managing widely distributed software at scale requires careful design related to backwards compatibility, versioning, and upgrading. The OpenTelemetry approach is described below. If you are planning on using OpenTelemetry, it can be helpful to understand how we approach this problem.

diff --git a/text/0149-exponential-histogram.md b/text/0149-exponential-histogram.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Add exponential bucketing to histogram protobuf
 
 Add exponential bucketing to histogram protobuf

diff --git a/text/0152-telemetry-schemas.md b/text/0152-telemetry-schemas.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Telemetry Schemas
 
 * [Motivation](#motivation)

diff --git a/text/0155-external-modules.md b/text/0155-external-modules.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Ecosystem Management
 
 Proposal how to leverage wider community contributing instrumentations and other packages.

diff --git a/text/0156-columnar-encoding.md b/text/0156-columnar-encoding.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # OTel Arrow Protocol Specification
 
 **Author**: Laurent Querel, F5 Inc.

diff --git a/text/0178-mapping-to-otlp-anyvalue.md b/text/0178-mapping-to-otlp-anyvalue.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Mapping Arbitrary Data to OTLP AnyValue
 
 This document defines how to map (convert) arbitrary data (e.g. in-memory

diff --git a/text/0182-otlp-remote-parent.md b/text/0182-otlp-remote-parent.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Export SpanContext.IsRemote in OTLP
 
 Update OTLP to indicate whether a span's parent is remote.

diff --git a/text/0199-support-elastic-common-schema-in-opentelemetry.md b/text/0199-support-elastic-common-schema-in-opentelemetry.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Merge Elastic Common Schema with OpenTelemetry Semantic Conventions
 
 ## Introduction

diff --git a/text/0201-scope-attributes.md b/text/0201-scope-attributes.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Introduce Scope Attributes
 
 This OTEP adds attributes to the Scope of a telemetry emitter (e.g. Tracer, Meter, LogEmitter).

diff --git a/text/0202-events-and-logs-api.md b/text/0202-events-and-logs-api.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Introducing Events and Logs API
 
 We introduce an Events and Logs API that is based on the OpenTelemetry Log signal, backed by LogRecord data model and LogEmitter SDK.

diff --git a/text/0225-configuration.md b/text/0225-configuration.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # OpenTelemetry Configuration
 
 A new configuration interface is proposed here in the form of a configuration model, which can be expressed as a file, and validated through a published schema.

diff --git a/text/0227-separate-semantic-conventions.md b/text/0227-separate-semantic-conventions.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Separate Semantic Conventions
 
 Move Semantic Conventions outside of the main Specifications and version them

diff --git a/text/0232-maturity-of-otel.md b/text/0232-maturity-of-otel.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Definition of maturity levels to be uniformly used by OpenTelemetry SIGs
 
 On 08 Mar 2023, the OpenTelemetry GC and TC held an OpenTelemetry Leadership summit, discussing various topics. One of the themes we discussed was establishing standard rules for describing the maturity of the OpenTelemetry project. This OTEP summarizes what was discussed there and is intended to have the wider community provide feedback.

diff --git a/text/0243-app-telemetry-schema-vision-roadmap.md b/text/0243-app-telemetry-schema-vision-roadmap.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Introducing Application Telemetry Schema in OpenTelemetry - Vision and Roadmap
 
 ----

diff --git a/text/0258-env-context-baggage-carriers.md b/text/0258-env-context-baggage-carriers.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Environment Variable Specification for Context and Baggage Propagation
 
 This is a proposal to add Environment Variables to the OpenTelemetry

diff --git a/text/0265-event-vision.md b/text/0265-event-vision.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Event Basics
 
 ## Motivation

diff --git a/text/0266-move-oteps-to-spec.md b/text/0266-move-oteps-to-spec.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Move OTEPS to the Specification repository
 
 Let's move OTEP documentation and PRs back into the github.com/open-telemetry/opentelemetry-specification repository.

diff --git a/text/entities/0256-entities-data-model.md b/text/entities/0256-entities-data-model.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Entities Data Model, Part 1
 
 This is a proposal of a data model to represent entities. The purpose of the data model

diff --git a/text/entities/0264-resource-and-entities.md b/text/entities/0264-resource-and-entities.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Resource and Entities - Data Model Part 2
 
 This is a proposal to address Resource and Entity data model interactions,

diff --git a/text/experimental/0121-config-service.md b/text/experimental/0121-config-service.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # A Dynamic Configuration Service for the SDK
 
 This proposal is a request to develop a prototype to configure metric collection periods. Per-metric and tracing configuration is also intended to be added, with details left for a later iteration.

diff --git a/text/logs/0091-logs-vocabulary.md b/text/logs/0091-logs-vocabulary.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Logs: Vocabulary
 
 This documents defines the vocabulary for logs to be used across OpenTelemetry project.

diff --git a/text/logs/0092-logs-vision.md b/text/logs/0092-logs-vision.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # OpenTelemetry Logs Vision
 
 The following are high-level items that define our long-term vision for

diff --git a/text/logs/0097-log-data-model.md b/text/logs/0097-log-data-model.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Log Data Model
 
 Introduce Data Model for Log Records as it is understood by OpenTelemetry.

diff --git a/text/logs/0130-logs-1.0ga-definition.md b/text/logs/0130-logs-1.0ga-definition.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Logs GA Scope
 
 This document defines what's in scope for OpenTelemetry Logs General

diff --git a/text/logs/0150-logging-library-sdk.md b/text/logs/0150-logging-library-sdk.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Logging Library SDK Prototype Specification
 
 Initial draft specification to create prototypes of OpenTelemetry Logging

diff --git a/text/metrics/0003-measure-metric-type.md b/text/metrics/0003-measure-metric-type.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Consolidate pre-aggregated and raw metrics APIs
 
 ## Foreword

diff --git a/text/metrics/0008-metric-observer.md b/text/metrics/0008-metric-observer.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Metrics observer specification
 
 **Status:** Superceded entirely by [0072-metric-observer](0072-metric-observer.md)

diff --git a/text/metrics/0009-metric-handles.md b/text/metrics/0009-metric-handles.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Metric Handle API specification
 
 Specify the behavior of the Metrics API "Handle" type, for efficient repeated-use of metric instruments.

diff --git a/text/metrics/0010-cumulative-to-counter.md b/text/metrics/0010-cumulative-to-counter.md
@@ -1,3 +1,8 @@
+> [!WARNING]
+> OTEPs have been moved to the [Specification](https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/)
+> repository. This repository has been preserved for reference purposes.
+> Please otherwise refer to the Specification.
+
 # Rename "Cumulative" to "Counter" in the metrics API
 
 Prefer the name "Counter" as opposed to "Cumulative".