From caa705290bc0bc17615ab2fe0ad3030a2b459a9d Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 19 May 2023 12:43:00 -0400 Subject: [PATCH] Rename ./specification to ./docs (#469) * Rename ./specification to ./docs * Add Hugo front matter, and some README copyedits --- README.md | 4 ++-- docs/README.md | 16 ++++++++++++++++ {specification => docs}/design-goals.md | 8 ++++++++ .../img/otlp-client-server.png | Bin {specification => docs}/img/otlp-concurrent.png | Bin .../img/otlp-multi-destination.png | Bin .../img/otlp-request-response.png | Bin {specification => docs}/img/otlp-sequential.png | Bin {specification => docs}/requirements.md | 8 ++++++++ specification/otlp.md => docs/specification.md | 10 ++++++++++ specification/README.md | 8 -------- 11 files changed, 44 insertions(+), 10 deletions(-) create mode 100644 docs/README.md rename {specification => docs}/design-goals.md (82%) rename {specification => docs}/img/otlp-client-server.png (100%) rename {specification => docs}/img/otlp-concurrent.png (100%) rename {specification => docs}/img/otlp-multi-destination.png (100%) rename {specification => docs}/img/otlp-request-response.png (100%) rename {specification => docs}/img/otlp-sequential.png (100%) rename {specification => docs}/requirements.md (96%) rename specification/otlp.md => docs/specification.md (98%) delete mode 100644 specification/README.md diff --git a/README.md b/README.md index 25d25c222..324008ff6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This repo is currently pinned to [v0.19.0](https://github.com/open-telemetry/ope [![Build Check](https://github.com/open-telemetry/opentelemetry-proto/workflows/Build%20Check/badge.svg?branch=main)](https://github.com/open-telemetry/opentelemetry-proto/actions?query=workflow%3A%22Build+Check%22+branch%3Amain) -This repository contains the [OTLP protocol specification](specification/otlp.md) +This repository contains the [OTLP protocol specification](docs/specification.md) and the corresponding Language Independent Interface Types ([.proto files](opentelemetry/proto)). ## Language Independent Interface Types @@ -64,7 +64,7 @@ Components marked `Stable` provide the following guarantees: - Service names and service package names will not change. - Service method names will not change. [from 1.0.0] - Service method parameter names will not change. [from 1.0.0] -- Service method parameter types and return types will not change. [from 1.0.0] +- Service method parameter types and return types will not change. [from 1.0.0] - Service method kind (unary vs streaming) will not change. - Names of messages and enums will not change. [from 1.0.0] - Numbers assigned to enum choices will not change. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..21c52b646 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,16 @@ + + +# OpenTelemetry Protocol (OTLP) + +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/specification/design-goals.md b/docs/design-goals.md similarity index 82% rename from specification/design-goals.md rename to docs/design-goals.md index e51a4d70e..06255b2f2 100644 --- a/specification/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/specification/img/otlp-client-server.png b/docs/img/otlp-client-server.png similarity index 100% rename from specification/img/otlp-client-server.png rename to docs/img/otlp-client-server.png diff --git a/specification/img/otlp-concurrent.png b/docs/img/otlp-concurrent.png similarity index 100% rename from specification/img/otlp-concurrent.png rename to docs/img/otlp-concurrent.png diff --git a/specification/img/otlp-multi-destination.png b/docs/img/otlp-multi-destination.png similarity index 100% rename from specification/img/otlp-multi-destination.png rename to docs/img/otlp-multi-destination.png diff --git a/specification/img/otlp-request-response.png b/docs/img/otlp-request-response.png similarity index 100% rename from specification/img/otlp-request-response.png rename to docs/img/otlp-request-response.png diff --git a/specification/img/otlp-sequential.png b/docs/img/otlp-sequential.png similarity index 100% rename from specification/img/otlp-sequential.png rename to docs/img/otlp-sequential.png diff --git a/specification/requirements.md b/docs/requirements.md similarity index 96% rename from specification/requirements.md rename to docs/requirements.md index 5d1f1cb66..7a319dd1f 100644 --- a/specification/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/specification/otlp.md b/docs/specification.md similarity index 98% rename from specification/otlp.md rename to docs/specification.md index dabf4c53c..976a81eb9 100644 --- a/specification/otlp.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) diff --git a/specification/README.md b/specification/README.md deleted file mode 100644 index 4797f16fc..000000000 --- a/specification/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# OpenTelemetry Protocol - -This is the specification of new OpenTelemetry protocol (OTLP). - -- [Design Goals](design-goals.md). -- [Requirements](requirements.md). -- [Specification](otlp.md). -- [SDK Exporter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md).