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

[editorial] Fix doc page titles and add Hugo front matter #175

Merged
merged 3 commits into from
Jul 7, 2023
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
16 changes: 15 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Semantic Conventions
# no_list: true
cascade:
body_class: otel-docs-spec
github_repo: &repo https://github.com/open-telemetry/semantic-conventions
github_subdir: docs
path_base_for_github_subdir: content/en/docs/specs/semconv/
jsuereth marked this conversation as resolved.
Show resolved Hide resolved
github_project_repo: *repo
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/_index.md
to: README.md
--->

# OpenTelemetry Semantic Conventions

The Semantic Conventions define a common set of (semantic) attributes which provide meaning to data when collecting, producing and consuming it.
Expand All @@ -7,8 +21,8 @@ The benefit to using Semantic Conventions is in following a common naming scheme
Semantic Conventions are defined for the following areas:

* **[General](general/README.md): General Semantic Conventions**.
* [CloudEvents](cloudevents/README.md): Semantic Conventions for the CloudEvents specification.
* [Cloud Providers](cloud-providers/README.md): Semantic Conventions for cloud providers libraries.
* [CloudEvents](cloudevents/README.md): Semantic Conventions for the CloudEvents specification.
* [Database](database/README.md): Semantic Conventions for database operations.
* [Exceptions](exceptions/README.md): Semantic Conventions for exceptions.
* [FaaS](faas/README.md): Semantic Conventions for Function as a Service (FaaS) operations.
Expand Down
9 changes: 8 additions & 1 deletion docs/cloud-providers/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Semantic conventions for cloud providers
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Cloud Providers
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/cloud-providers/_index.md
to: cloud-providers/README.md
--->

# Semantic Conventions for Cloud Providers

**Status**: [Experimental][DocumentStatus]

Expand Down
6 changes: 5 additions & 1 deletion docs/cloud-providers/aws-sdk.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for AWS SDK
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: AWS SDK
--->

# Semantic Conventions for AWS SDK

**Status**: [Experimental][DocumentStatus]

Expand Down
9 changes: 8 additions & 1 deletion docs/cloudevents/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Semantic conventions for CloudEvents
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: CloudEvents
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/cloudevents/_index.md
to: cloudevents/README.md
--->

# Semantic Conventions for CloudEvents

**Status**: [Experimental][DocumentStatus]

Expand Down
6 changes: 5 additions & 1 deletion docs/cloudevents/cloudevents-spans.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for CloudEvents spans
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: CloudEvents Spans
--->

# Semantic Conventions for CloudEvents Spans

**Status**: [Experimental][DocumentStatus]

Expand Down
9 changes: 8 additions & 1 deletion docs/database/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Semantic conventions for database calls and systems
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Database
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/database/_index.md
to: database/README.md
--->

# Semantic Conventions for Database Calls and Systems

**Status**: [Experimental][DocumentStatus]

Expand Down
4 changes: 4 additions & 0 deletions docs/database/cassandra.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Cassandra
--->

# Semantic Conventions for Cassandra

**Status**: [Experimental][DocumentStatus]
Expand Down
4 changes: 4 additions & 0 deletions docs/database/cosmosdb.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Cosmos DB
--->

# Semantic Conventions for Microsoft Cosmos DB

**Status**: [Experimental][DocumentStatus]
Expand Down
4 changes: 4 additions & 0 deletions docs/database/couchdb.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: CouchDB
--->

# Semantic Conventions for CouchDB

**Status**: [Experimental][DocumentStatus]
Expand Down
2 changes: 1 addition & 1 deletion docs/database/database-metrics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Database
linkTitle: Metrics
--->

# Semantic Conventions for Database Metrics
Expand Down
6 changes: 5 additions & 1 deletion docs/database/database-spans.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for database client calls
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Client Calls
--->

# Semantic Conventions for Database Client Calls

**Status**: [Experimental][DocumentStatus]

Expand Down
4 changes: 4 additions & 0 deletions docs/database/dynamodb.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: AWS DynamoDB
--->

# Semantic Conventions for AWS DynamoDB

**Status**: [Experimental][DocumentStatus]
Expand Down
6 changes: 5 additions & 1 deletion docs/database/elasticsearch.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for Elasticsearch
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Elasticsearch
--->

# Semantic Conventions for Elasticsearch

**Status**: [Experimental][DocumentStatus]

Expand Down
6 changes: 5 additions & 1 deletion docs/database/graphql.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for GraphQL Server
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: GraphQL Server
--->

# Semantic Conventions for GraphQL Server

**Status**: [Experimental][DocumentStatus]

Expand Down
4 changes: 4 additions & 0 deletions docs/database/hbase.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: HBase
--->

# Semantic Conventions for HBase

**Status**: [Experimental][DocumentStatus]
Expand Down
4 changes: 4 additions & 0 deletions docs/database/mongodb.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: MongoDB
--->

# Semantic Conventions for MongoDB

**Status**: [Experimental][DocumentStatus]
Expand Down
4 changes: 4 additions & 0 deletions docs/database/mssql.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: MSSQL
--->

# Semantic Conventions for MSSQL

**Status**: [Experimental][DocumentStatus]
Expand Down
4 changes: 4 additions & 0 deletions docs/database/redis.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Redis
--->

# Semantic Conventions for Redis

**Status**: [Experimental][DocumentStatus]
Expand Down
6 changes: 5 additions & 1 deletion docs/database/sql.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic Conventions for SQL databases
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: SQL
--->

# Semantic Conventions for SQL Databases

**Status**: [Experimental][DocumentStatus]

Expand Down
9 changes: 8 additions & 1 deletion docs/exceptions/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Semantic conventions for Exceptions
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Exceptions
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/exceptions/_index.md
to: exceptions/README.md
--->

# Semantic Conventions for Exceptions

**Status**: [Experimental][DocumentStatus]

Expand Down
4 changes: 4 additions & 0 deletions docs/exceptions/exceptions-logs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Logs
--->

# Semantic Conventions for Exceptions in Logs

**Status**: [Experimental][DocumentStatus]
Expand Down
4 changes: 4 additions & 0 deletions docs/exceptions/exceptions-spans.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Spans
--->

# Semantic Conventions for Exceptions on Spans

**Status**: [Experimental][DocumentStatus]
Expand Down
9 changes: 8 additions & 1 deletion docs/faas/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Semantic conventions for FaaS
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: FaaS
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/faas/_index.md
to: faas/README.md
--->

# Semantic Conventions for Function-as-a-Service

**Status**: [Experimental][DocumentStatus]

Expand Down
2 changes: 1 addition & 1 deletion docs/faas/faas-metrics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: FaaS
linkTitle: Metrics
jsuereth marked this conversation as resolved.
Show resolved Hide resolved
--->

# Semantic Conventions for FaaS Metrics
Expand Down
6 changes: 5 additions & 1 deletion docs/faas/faas-spans.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for FaaS spans
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Spans
--->

# Semantic Conventions for FaaS Spans

**Status**: [Experimental][DocumentStatus]

Expand Down
9 changes: 8 additions & 1 deletion docs/feature-flags/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Semantic conventions for Feature Flags
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Feature Flags
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/feature-flags/_index.md
to: feature-flags/README.md
--->

# Semantic Conventions for Feature Flags

**Status**: [Experimental][DocumentStatus]

Expand Down
4 changes: 4 additions & 0 deletions docs/feature-flags/feature-flags-logs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Logs
--->

# Semantic Conventions for Feature Flags in Logs

**Status**: [Experimental][DocumentStatus]
Expand Down
6 changes: 5 additions & 1 deletion docs/feature-flags/feature-flags-spans.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for Feature Flags in Spans
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Spans
--->

# Semantic Conventions for Feature Flags in Spans

**Status**: [Experimental][DocumentStatus]

Expand Down
8 changes: 8 additions & 0 deletions docs/general/README.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: General
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/general/_index.md
to: general/README.md
weight: -1
--->

# General Semantic Conventions

This document defines general Semantic Conventions for spans, metrics, logs and events.
Expand Down
6 changes: 5 additions & 1 deletion docs/general/events-general.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic Convention for event attributes
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Events
--->

# Semantic Conventions for Event Attributes

**Status**: [Experimental][DocumentStatus]

Expand Down
6 changes: 5 additions & 1 deletion docs/general/general-attributes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# General attributes
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Attributes
--->

# General Attributes

**Status**: [Experimental][DocumentStatus]

Expand Down
6 changes: 5 additions & 1 deletion docs/general/logs-general.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# General logs attributes
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Logs
--->

# General Logs Attributes

**Status**: [Experimental][DocumentStatus]

Expand Down
4 changes: 4 additions & 0 deletions docs/general/metrics-general.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Metrics
--->

# Metrics Semantic Conventions

**Status**: [Mixed][DocumentStatus]
Expand Down
6 changes: 5 additions & 1 deletion docs/general/trace-compatibility.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for tracing Compatibility components
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Tracing Compatibility
--->

# Semantic Conventions for Tracing Compatibility Components

**Status**: [Experimental][DocumentStatus]

Expand Down
4 changes: 4 additions & 0 deletions docs/general/trace-general.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Trace
--->

# Trace Semantic Conventions

**Status**: [Experimental][DocumentStatus]
Expand Down
9 changes: 8 additions & 1 deletion docs/http/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Semantic conventions for HTTP
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: HTTP
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/http/_index.md
to: http/README.md
--->

# Semantic Conventions for HTTP

**Status**: [Experimental, Feature-freeze][DocumentStatus]

Expand Down
2 changes: 1 addition & 1 deletion docs/http/http-metrics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: HTTP
linkTitle: Metrics
--->

# Semantic Conventions for HTTP Metrics
Expand Down
6 changes: 5 additions & 1 deletion docs/http/http-spans.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Semantic conventions for HTTP spans
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Spans
--->

# Semantic Conventions for HTTP Spans

**Status**: [Experimental, Feature-freeze][DocumentStatus]

Expand Down
9 changes: 8 additions & 1 deletion docs/messaging/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Semantic conventions for Messaging systems
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Messaging Systems
path_base_for_github_subdir:
from: content/en/docs/specs/semconv/messaging/_index.md
to: messaging/README.md
--->

# Semantic Conventions for Messaging Systems

**Status**: [Experimental][DocumentStatus]

Expand Down
Loading