Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename ./specification to ./docs #469

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
tigrannajaryan marked this conversation as resolved.
Show resolved Hide resolved
- 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.
Expand Down
16 changes: 16 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line 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)
8 changes: 8 additions & 0 deletions specification/design-goals.md → docs/design-goals.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
File renamed without changes
File renamed without changes
8 changes: 8 additions & 0 deletions specification/requirements.md → docs/requirements.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
10 changes: 10 additions & 0 deletions specification/otlp.md → docs/specification.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
8 changes: 0 additions & 8 deletions specification/README.md

This file was deleted.