From 5c19b4e86880e0ff9d680ef5633d6a7e81a85bc3 Mon Sep 17 00:00:00 2001
From: Patrice Chalin <chalin@users.noreply.github.com>
Date: Thu, 23 Jun 2022 00:31:40 -0400
Subject: [PATCH] [editorial] Ensure metrics subsections have a README (#2629)

---
 specification/metrics/semantic_conventions/README.md        | 6 ++++--
 .../metrics/semantic_conventions/database-metrics.md        | 6 +++++-
 specification/metrics/semantic_conventions/faas-metrics.md  | 6 +++++-
 specification/metrics/semantic_conventions/http-metrics.md  | 6 +++++-
 .../metrics/semantic_conventions/instrumentation/README.md  | 1 +
 .../metrics/semantic_conventions/instrumentation/kafka.md   | 4 ++++
 .../metrics/semantic_conventions/openmetrics-guidelines.md  | 4 ++++
 .../metrics/semantic_conventions/process-metrics.md         | 4 ++++
 specification/metrics/semantic_conventions/rpc.md           | 4 ++++
 .../semantic_conventions/runtime-environment-metrics.md     | 4 ++++
 .../metrics/semantic_conventions/system-metrics.md          | 4 ++++
 11 files changed, 44 insertions(+), 5 deletions(-)
 create mode 100644 specification/metrics/semantic_conventions/instrumentation/README.md

diff --git a/specification/metrics/semantic_conventions/README.md b/specification/metrics/semantic_conventions/README.md
index ca4aba539..d49345e3a 100644
--- a/specification/metrics/semantic_conventions/README.md
+++ b/specification/metrics/semantic_conventions/README.md
@@ -1,9 +1,11 @@
+<!---
+linkTitle: Semantic Conventions
+--->
+
 # Metrics Semantic Conventions
 
 **Status**: [Experimental](../../document-status.md)
 
-<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
-
 <!-- toc -->
 
 - [General Guidelines](#general-guidelines)
diff --git a/specification/metrics/semantic_conventions/database-metrics.md b/specification/metrics/semantic_conventions/database-metrics.md
index 353e748b3..0f29e6bf2 100644
--- a/specification/metrics/semantic_conventions/database-metrics.md
+++ b/specification/metrics/semantic_conventions/database-metrics.md
@@ -1,4 +1,8 @@
-# General
+<!---
+linkTitle: Database
+--->
+
+# Semantic Conventions for Database Metrics
 
 **Status**: [Experimental](../../document-status.md)
 
diff --git a/specification/metrics/semantic_conventions/faas-metrics.md b/specification/metrics/semantic_conventions/faas-metrics.md
index 0d83b0b19..e789e0561 100644
--- a/specification/metrics/semantic_conventions/faas-metrics.md
+++ b/specification/metrics/semantic_conventions/faas-metrics.md
@@ -1,4 +1,8 @@
-# General
+<!---
+linkTitle: FaaS
+--->
+
+# Semantic Conventions for FaaS Metrics
 
 **Status**: [Experimental](../../document-status.md)
 
diff --git a/specification/metrics/semantic_conventions/http-metrics.md b/specification/metrics/semantic_conventions/http-metrics.md
index bbb471e96..1969274bf 100644
--- a/specification/metrics/semantic_conventions/http-metrics.md
+++ b/specification/metrics/semantic_conventions/http-metrics.md
@@ -1,4 +1,8 @@
-# General
+<!---
+linkTitle: HTTP
+--->
+
+# Semantic Conventions for HTTP Metrics
 
 **Status**: [Experimental](../../document-status.md)
 
diff --git a/specification/metrics/semantic_conventions/instrumentation/README.md b/specification/metrics/semantic_conventions/instrumentation/README.md
new file mode 100644
index 000000000..ab7111ba6
--- /dev/null
+++ b/specification/metrics/semantic_conventions/instrumentation/README.md
@@ -0,0 +1 @@
+# Instrumentation
diff --git a/specification/metrics/semantic_conventions/instrumentation/kafka.md b/specification/metrics/semantic_conventions/instrumentation/kafka.md
index 5474de1f8..5665f70b7 100644
--- a/specification/metrics/semantic_conventions/instrumentation/kafka.md
+++ b/specification/metrics/semantic_conventions/instrumentation/kafka.md
@@ -1,3 +1,7 @@
+<!---
+linkTitle: Kafka
+--->
+
 # Instrumenting Kafka
 
 **Status**: [Experimental](../../../document-status.md)
diff --git a/specification/metrics/semantic_conventions/openmetrics-guidelines.md b/specification/metrics/semantic_conventions/openmetrics-guidelines.md
index 72108a2dc..d8022b38f 100644
--- a/specification/metrics/semantic_conventions/openmetrics-guidelines.md
+++ b/specification/metrics/semantic_conventions/openmetrics-guidelines.md
@@ -1,3 +1,7 @@
+<!---
+linkTitle: OpenMetrics
+--->
+
 # Guidance for Interoperating with OpenMetrics
 
 **Status**: [Experimental](../../document-status.md)
diff --git a/specification/metrics/semantic_conventions/process-metrics.md b/specification/metrics/semantic_conventions/process-metrics.md
index 2358c16ac..cdc87143a 100644
--- a/specification/metrics/semantic_conventions/process-metrics.md
+++ b/specification/metrics/semantic_conventions/process-metrics.md
@@ -1,3 +1,7 @@
+<!---
+linkTitle: Process
+--->
+
 # Semantic Conventions for OS Process Metrics
 
 **Status**: [Experimental](../../document-status.md)
diff --git a/specification/metrics/semantic_conventions/rpc.md b/specification/metrics/semantic_conventions/rpc.md
index 6034f46c0..28e84218f 100644
--- a/specification/metrics/semantic_conventions/rpc.md
+++ b/specification/metrics/semantic_conventions/rpc.md
@@ -1,3 +1,7 @@
+<!---
+linkTitle: RPC
+--->
+
 # General RPC conventions
 
 **Status**: [Experimental](../../document-status.md)
diff --git a/specification/metrics/semantic_conventions/runtime-environment-metrics.md b/specification/metrics/semantic_conventions/runtime-environment-metrics.md
index eae8dcd81..fe3ff204e 100644
--- a/specification/metrics/semantic_conventions/runtime-environment-metrics.md
+++ b/specification/metrics/semantic_conventions/runtime-environment-metrics.md
@@ -1,3 +1,7 @@
+<!---
+linkTitle: Runtime Environment
+--->
+
 # Semantic Conventions for Runtime Environment Metrics
 
 **Status**: [Experimental](../../document-status.md)
diff --git a/specification/metrics/semantic_conventions/system-metrics.md b/specification/metrics/semantic_conventions/system-metrics.md
index 9a5b23bad..b4ad4d19e 100644
--- a/specification/metrics/semantic_conventions/system-metrics.md
+++ b/specification/metrics/semantic_conventions/system-metrics.md
@@ -1,3 +1,7 @@
+<!---
+linkTitle: System
+--->
+
 # Semantic Conventions for System Metrics
 
 **Status**: [Experimental](../../document-status.md)