Add Hugo front matter, and some README copyedits

open-telemetry · May 11, 2023 · 8263ca3 · 8263ca3
1 parent 11fd8cd
commit 8263ca3
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 6 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,8 +1,16 @@
-# OpenTelemetry Protocol
+<!--- 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
+--->
 
-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
@@ -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:

diff --git a/docs/requirements.md b/docs/requirements.md
@@ -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.

diff --git a/docs/specification.md b/docs/specification.md
@@ -1,3 +1,12 @@
+<!--- Hugo front matter used to generate the website version of this page:
+linkTitle: Requirements
+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)