From c17aabc8c20799e7bc2c376696ba496ce34cd448 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 11 May 2023 13:15:31 -0400 Subject: [PATCH] Add Hugo front matter, and some README copyedits --- docs/README.md | 20 ++++++++++++++------ docs/design-goals.md | 8 ++++++++ docs/requirements.md | 8 ++++++++ docs/specification.md | 10 ++++++++++ 4 files changed, 40 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index cff969420..21c52b646 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,16 @@ -# OpenTelemetry Protocol + -This is the specification of new OpenTelemetry protocol (OTLP). +# OpenTelemetry Protocol (OTLP) -- [Design Goals](design-goals.md). -- [Requirements](requirements.md). -- [Specification](specification.md). -- [SDK Exporter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md). +This is the specification of the OpenTelemetry Protocol (OTLP). + +- [Design Goals](design-goals.md) +- [Requirements](requirements.md) +- [Specification](specification.md) +- [SDK Exporter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md) diff --git a/docs/design-goals.md b/docs/design-goals.md index e51a4d70e..06255b2f2 100644 --- a/docs/design-goals.md +++ b/docs/design-goals.md @@ -1,3 +1,11 @@ + + # Design Goals for OpenTelemetry Wire Protocol We want to design a telemetry data exchange protocol that has the following characteristics: diff --git a/docs/requirements.md b/docs/requirements.md index 5d1f1cb66..7a319dd1f 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -1,3 +1,11 @@ + + # OpenTelemetry Protocol Requirements This document will drive OpenTelemetry Protocol design and RFC. diff --git a/docs/specification.md b/docs/specification.md index dabf4c53c..976a81eb9 100644 --- a/docs/specification.md +++ b/docs/specification.md @@ -1,3 +1,13 @@ + + # OpenTelemetry Protocol Specification **Status**: [Stable](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md)