Rename ./specification to ./docs (#469)

* Rename ./specification to ./docs

* Add Hugo front matter, and some README copyedits
pull/474/head^2
Patrice Chalin 2 years ago committed by GitHub
parent 840db1f143
commit 8da5aed73e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 4
      README.md
  2. 16
      docs/README.md
  3. 8
      docs/design-goals.md
  4. 0
      docs/img/otlp-client-server.png
  5. 0
      docs/img/otlp-concurrent.png
  6. 0
      docs/img/otlp-multi-destination.png
  7. 0
      docs/img/otlp-request-response.png
  8. 0
      docs/img/otlp-sequential.png
  9. 8
      docs/requirements.md
  10. 10
      docs/specification.md
  11. 8
      specification/README.md

@ -2,7 +2,7 @@
[![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
@ -56,7 +56,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.

@ -0,0 +1,16 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: OTLP
aliases:
- /docs/reference/specification/protocol
- /docs/specs/otel/protocol
spelling: cSpell:ignore otel OTLP
--->
# 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)

@ -1,3 +1,11 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Design goals
aliases:
- /docs/reference/specification/protocol/design-goals
- /docs/specs/otel/protocol/design-goals
spelling: cSpell:ignore backpressure otel
--->
# Design Goals for OpenTelemetry Wire Protocol
We want to design a telemetry data exchange protocol that has the following characteristics:

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Before

Width:  |  Height:  |  Size: 9.7 KiB

After

Width:  |  Height:  |  Size: 9.7 KiB

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

@ -1,3 +1,11 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Requirements
aliases:
- /docs/reference/specification/protocol/requirements
- /docs/specs/otel/protocol/requirements
spelling: cSpell:ignore backpressure dealocations otel reconnections
--->
# OpenTelemetry Protocol Requirements
This document will drive OpenTelemetry Protocol design and RFC.

@ -1,3 +1,13 @@
<!--- Hugo front matter used to generate the website version of this page:
title: OTLP Specification
linkTitle: Specification
aliases:
- /docs/reference/specification/protocol/otlp
- /docs/specs/otel/protocol/otlp
spelling:
cSpell:ignore backpressure dealocations otel otlp protobuf reconnections retryable OTEP
--->
# OpenTelemetry Protocol Specification
**Status**: [Stable](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md)

@ -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).
Loading…
Cancel
Save