From fa5eca7aa9d1fc5e11d09e9aec1e67aa2c0afb1f Mon Sep 17 00:00:00 2001
From: Patrice Chalin <chalin@users.noreply.github.com>
Date: Wed, 7 Feb 2024 10:42:40 -0500
Subject: [PATCH] [editorial] Add Hugo front-matter path base (#3862)

- Contributes to
https://github.com/open-telemetry/opentelemetry.io/issues/3922
- Either updates or adds `path_base_for_github_subdir` to selected page
front matter

/cc @theletterf @svrnm
---
 specification/README.md                       | 5 ++++-
 specification/baggage/README.md               | 6 ++++++
 specification/common/README.md                | 3 +++
 specification/compatibility/README.md         | 6 ++++++
 specification/configuration/README.md         | 6 ++++++
 specification/context/README.md               | 3 +++
 specification/logs/README.md                  | 3 +++
 specification/metrics/README.md               | 3 +++
 specification/metrics/sdk_exporters/README.md | 3 +++
 specification/protocol/README.md              | 3 +++
 specification/resource/README.md              | 6 ++++++
 specification/schemas/README.md               | 3 +++
 specification/trace/README.md                 | 6 ++++++
 specification/trace/sdk_exporters/README.md   | 3 +++
 14 files changed, 58 insertions(+), 1 deletion(-)

diff --git a/specification/README.md b/specification/README.md
index c74eddb6d9b..e6081f1c1cd 100644
--- a/specification/README.md
+++ b/specification/README.md
@@ -5,8 +5,11 @@ cascade:
   body_class: otel-docs-spec
   github_repo: &repo https://github.com/open-telemetry/opentelemetry-specification
   github_subdir: specification
-  path_base_for_github_subdir: content/en/docs/specs/otel/
+  path_base_for_github_subdir: tmp/otel/specification
   github_project_repo: *repo
+path_base_for_github_subdir:
+  from: tmp/otel/specification/_index.md
+  to: README.md
 --->
 
 # OpenTelemetry Specification
diff --git a/specification/baggage/README.md b/specification/baggage/README.md
index f67883538e8..4f32dc019de 100644
--- a/specification/baggage/README.md
+++ b/specification/baggage/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/baggage/_index.md
+  to: baggage/README.md
+--->
+
 # Baggage
diff --git a/specification/common/README.md b/specification/common/README.md
index 800ebc9ccdf..a9d993b3b18 100644
--- a/specification/common/README.md
+++ b/specification/common/README.md
@@ -1,6 +1,9 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Common concepts
 aliases: [/docs/reference/specification/common/common]
+path_base_for_github_subdir:
+  from: tmp/otel/specification/common/_index.md
+  to: common/README.md
 --->
 
 # Common specification concepts
diff --git a/specification/compatibility/README.md b/specification/compatibility/README.md
index 9ccd656b373..40e6460cc2f 100644
--- a/specification/compatibility/README.md
+++ b/specification/compatibility/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/compatibility/_index.md
+  to: compatibility/README.md
+--->
+
 # Compatibility
diff --git a/specification/configuration/README.md b/specification/configuration/README.md
index a025a48b1bf..af3fe3bb908 100644
--- a/specification/configuration/README.md
+++ b/specification/configuration/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/configuration/_index.md
+  to: configuration/README.md
+--->
+
 # Configuration
diff --git a/specification/context/README.md b/specification/context/README.md
index 388534207d7..5e2e56e5434 100644
--- a/specification/context/README.md
+++ b/specification/context/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 aliases: [/docs/reference/specification/context/context]
+path_base_for_github_subdir:
+  from: tmp/otel/specification/context/_index.md
+  to: context/README.md
 --->
 
 # Context
diff --git a/specification/logs/README.md b/specification/logs/README.md
index eaf1ab28212..b7ac1091ce3 100644
--- a/specification/logs/README.md
+++ b/specification/logs/README.md
@@ -1,6 +1,9 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Logs
 aliases: [/docs/reference/specification/logs/overview]
+path_base_for_github_subdir:
+  from: tmp/otel/specification/logs/_index.md
+  to: logs/README.md
 --->
 
 # OpenTelemetry Logging
diff --git a/specification/metrics/README.md b/specification/metrics/README.md
index 8fad95d83a7..4df658b40c7 100644
--- a/specification/metrics/README.md
+++ b/specification/metrics/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Metrics
+path_base_for_github_subdir:
+  from: tmp/otel/specification/metrics/_index.md
+  to: metrics/README.md
 --->
 
 # OpenTelemetry Metrics
diff --git a/specification/metrics/sdk_exporters/README.md b/specification/metrics/sdk_exporters/README.md
index d9ed247a055..7d4828f807a 100644
--- a/specification/metrics/sdk_exporters/README.md
+++ b/specification/metrics/sdk_exporters/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Exporters
+path_base_for_github_subdir:
+  from: tmp/otel/specification/metrics/sdk_exporters/_index.md
+  to: metrics/sdk_exporters/README.md
 --->
 
 # Metrics Exporters
diff --git a/specification/protocol/README.md b/specification/protocol/README.md
index 35972f5e1f6..ad30cb7d36a 100644
--- a/specification/protocol/README.md
+++ b/specification/protocol/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Protocol
+path_base_for_github_subdir:
+  from: tmp/otel/specification/protocol/_index.md
+  to: protocol/README.md
 --->
 
 # OpenTelemetry Protocol
diff --git a/specification/resource/README.md b/specification/resource/README.md
index 81dcb9f856a..26d8f4eca97 100644
--- a/specification/resource/README.md
+++ b/specification/resource/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/resource/_index.md
+  to: resource/README.md
+--->
+
 # Resource
diff --git a/specification/schemas/README.md b/specification/schemas/README.md
index ff3502ef917..c778d6fd9c7 100644
--- a/specification/schemas/README.md
+++ b/specification/schemas/README.md
@@ -1,6 +1,9 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Schemas
 aliases: [/docs/reference/specification/schemas/overview]
+path_base_for_github_subdir:
+  from: tmp/otel/specification/schemas/_index.md
+  to: schemas/README.md
 --->
 
 # Telemetry Schemas
diff --git a/specification/trace/README.md b/specification/trace/README.md
index 1b70b313e29..aff90f79a55 100644
--- a/specification/trace/README.md
+++ b/specification/trace/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/trace/_index.md
+  to: trace/README.md
+--->
+
 # Trace
diff --git a/specification/trace/sdk_exporters/README.md b/specification/trace/sdk_exporters/README.md
index 3613b6dc65a..106d744d130 100644
--- a/specification/trace/sdk_exporters/README.md
+++ b/specification/trace/sdk_exporters/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Exporters
+path_base_for_github_subdir:
+  from: tmp/otel/specification/trace/sdk_exporters/_index.md
+  to: trace/sdk_exporters/README.md
 --->
 
 # Trace Exporters