Skip to content

Commit cd9ea74

Browse files
committed
Switch unordered list symbol to hyphen
1 parent 2e68756 commit cd9ea74

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+579
-583
lines changed

docs/README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,32 @@ The benefit to using Semantic Conventions is in following a common naming scheme
1919

2020
Semantic Conventions are defined for the following areas:
2121

22-
* **[General](general/README.md): General Semantic Conventions**.
23-
* [CICD](cicd/README.md): Semantic Conventions for CICD systems.
24-
* [Cloud Providers](cloud-providers/README.md): Semantic Conventions for cloud providers libraries.
25-
* [CloudEvents](cloudevents/README.md): Semantic Conventions for the CloudEvents specification.
26-
* [Database](database/README.md): Semantic Conventions for database operations.
27-
* [Exceptions](exceptions/README.md): Semantic Conventions for exceptions.
28-
* [FaaS](faas/README.md): Semantic Conventions for Function as a Service (FaaS) operations.
29-
* [Feature Flags](feature-flags/README.md): Semantic Conventions for feature flag evaluations.
30-
* [Generative AI](gen-ai/README.md): Semantic Conventions for generative AI (LLM, etc.) operations.
31-
* [GraphQL](graphql/README.md): Semantic Conventions for GraphQL implementations.
32-
* [HTTP](http/README.md): Semantic Conventions for HTTP client and server operations.
33-
* [Messaging](messaging/README.md): Semantic Conventions for messaging operations and systems.
34-
* [Object Stores](object-stores/README.md): Semantic Conventions for object stores operations.
35-
* [RPC](rpc/README.md): Semantic Conventions for RPC client and server operations.
36-
* [System](system/README.md): System Semantic Conventions.
22+
- **[General](general/README.md): General Semantic Conventions**.
23+
- [CICD](cicd/README.md): Semantic Conventions for CICD systems.
24+
- [Cloud Providers](cloud-providers/README.md): Semantic Conventions for cloud providers libraries.
25+
- [CloudEvents](cloudevents/README.md): Semantic Conventions for the CloudEvents specification.
26+
- [Database](database/README.md): Semantic Conventions for database operations.
27+
- [Exceptions](exceptions/README.md): Semantic Conventions for exceptions.
28+
- [FaaS](faas/README.md): Semantic Conventions for Function as a Service (FaaS) operations.
29+
- [Feature Flags](feature-flags/README.md): Semantic Conventions for feature flag evaluations.
30+
- [Generative AI](gen-ai/README.md): Semantic Conventions for generative AI (LLM, etc.) operations.
31+
- [GraphQL](graphql/README.md): Semantic Conventions for GraphQL implementations.
32+
- [HTTP](http/README.md): Semantic Conventions for HTTP client and server operations.
33+
- [Messaging](messaging/README.md): Semantic Conventions for messaging operations and systems.
34+
- [Object Stores](object-stores/README.md): Semantic Conventions for object stores operations.
35+
- [RPC](rpc/README.md): Semantic Conventions for RPC client and server operations.
36+
- [System](system/README.md): System Semantic Conventions.
3737

3838
Semantic Conventions by signals:
3939

40-
* [Events](general/events.md): Semantic Conventions for event data.
41-
* [Logs](general/logs.md): Semantic Conventions for logs data.
42-
* [Metrics](general/metrics.md): Semantic Conventions for metrics.
43-
* [Profiles](general/profiles.md): Semantic Conventions for profiles.
44-
* [Resource](resource/README.md): Semantic Conventions for resources.
45-
* [Trace](general/trace.md): Semantic Conventions for traces and spans.
40+
- [Events](general/events.md): Semantic Conventions for event data.
41+
- [Logs](general/logs.md): Semantic Conventions for logs data.
42+
- [Metrics](general/metrics.md): Semantic Conventions for metrics.
43+
- [Profiles](general/profiles.md): Semantic Conventions for profiles.
44+
- [Resource](resource/README.md): Semantic Conventions for resources.
45+
- [Trace](general/trace.md): Semantic Conventions for traces and spans.
4646

4747
Also see:
4848

49-
* [How to write semantic conventions](how-to-write-conventions/README.md)
50-
* [Non-normative supplementary information](non-normative/README.md)
49+
- [How to write semantic conventions](how-to-write-conventions/README.md)
50+
- [Non-normative supplementary information](non-normative/README.md)

docs/app/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ linkTitle: App
88

99
Semantic conventions for Apps are defined for the following signals:
1010

11-
* [App Events](app-events.md)
11+
- [App Events](app-events.md)
1212

1313
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/azure/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document describes Azure Resource Logs, see [Azure Resource Log Top-level S
1010

1111
Semantic conventions are defined for the following signals:
1212

13-
* [Events](azure-events.md)
13+
- [Events](azure-events.md)
1414

1515
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status
1616
[AzureResourceSchema]: https://learn.microsoft.com/azure/azure-monitor/essentials/resource-logs-schema#top-level-common-schema

docs/browser/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ This document defines semantic conventions for Browser.
1010

1111
Semantic conventions are defined for the following signals:
1212

13-
* [Events](browser-events.md)
13+
- [Events](browser-events.md)
1414

1515
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/cicd/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ This document defines semantic conventions for Continuous Integration and Contin
1010

1111
Semantic conventions for CICD are defined for the following signals:
1212

13-
* [CICD Spans](cicd-spans.md): Semantic Conventions for CICD *spans*.
14-
* [CICD Metrics](cicd-metrics.md): Semantic Conventions for CICD *metrics*.
15-
* [CICD Logs](cicd-logs.md): Semantic Conventions for CICD *logs*.
13+
- [CICD Spans](cicd-spans.md): Semantic Conventions for CICD *spans*.
14+
- [CICD Metrics](cicd-metrics.md): Semantic Conventions for CICD *metrics*.
15+
- [CICD Logs](cicd-logs.md): Semantic Conventions for CICD *logs*.
1616

1717
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/cicd/cicd-metrics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ but more may be added in the future.
4141
It might be useful to gather metrics specific to each pipeline run.<br>
4242
Examples of such metrics include:
4343

44-
* host metrics like cpu, memory, disk of the worker on which a pipeline run executes
45-
* container metrics like cpu, memory requests and limits
46-
* runtime metrics of any processes executed as part of the pipeline run like JVM metrics
44+
- host metrics like cpu, memory, disk of the worker on which a pipeline run executes
45+
- container metrics like cpu, memory requests and limits
46+
- runtime metrics of any processes executed as part of the pipeline run like JVM metrics
4747

4848
These metrics could be used to correlate build failures with environment issues like overload or out-of-memory.
4949
They could also be used in pipeline-level aggregations to inform adjustements of allocated worker resources.

docs/cicd/cicd-spans.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ it's RECOMMENDED to:
159159
The following attributes can be important for making sampling decisions
160160
and SHOULD be provided **at span creation time** (if provided at all):
161161

162-
* [`cicd.pipeline.task.name`](/docs/registry/attributes/cicd.md)
163-
* [`cicd.pipeline.task.run.id`](/docs/registry/attributes/cicd.md)
164-
* [`cicd.pipeline.task.run.url.full`](/docs/registry/attributes/cicd.md)
162+
- [`cicd.pipeline.task.name`](/docs/registry/attributes/cicd.md)
163+
- [`cicd.pipeline.task.run.id`](/docs/registry/attributes/cicd.md)
164+
- [`cicd.pipeline.task.run.url.full`](/docs/registry/attributes/cicd.md)
165165

166166
---
167167

docs/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ linkTitle: CLI programs
88

99
Semantic conventions for CLI programs are defined for the following signals:
1010

11-
* [CLI Spans](cli-spans.md)
11+
- [CLI Spans](cli-spans.md)
1212

1313
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,43 +15,43 @@ database metrics and logs.
1515
> [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md)
1616
> (or prior):
1717
>
18-
> * SHOULD NOT change the version of the database conventions that they emit by
18+
> - SHOULD NOT change the version of the database conventions that they emit by
1919
> default in their existing major version. Conventions include (but are not
2020
> limited to) attributes, metric and span names, and unit of measure.
21-
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
21+
> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
2222
> in their existing major version as a comma-separated list of category-specific values
2323
> (e.g., http, databases, messaging). The list of values includes:
24-
> * `database` - emit the stable database conventions, and stop emitting
24+
> - `database` - emit the stable database conventions, and stop emitting
2525
> the experimental database conventions that the instrumentation emitted
2626
> previously.
27-
> * `database/dup` - emit both the experimental and stable database conventions,
27+
> - `database/dup` - emit both the experimental and stable database conventions,
2828
> allowing for a phased rollout of the stable semantic conventions.
29-
> * The default behavior (in the absence of one of these values) is to continue
29+
> - The default behavior (in the absence of one of these values) is to continue
3030
> emitting whatever version of the old experimental database conventions
3131
> the instrumentation was emitting previously.
32-
> * Note: `database/dup` has higher precedence than `database` in case both values are present
33-
> * SHOULD maintain (security patching at a minimum) their existing major version
32+
> - Note: `database/dup` has higher precedence than `database` in case both values are present
33+
> - SHOULD maintain (security patching at a minimum) their existing major version
3434
> for at least six months after it starts emitting both sets of conventions.
35-
> * MAY drop the environment variable in their next major version and emit only
35+
> - MAY drop the environment variable in their next major version and emit only
3636
> the stable database conventions.
3737
3838
Semantic conventions for database operations are defined for the following signals:
3939

40-
* [DB Spans](database-spans.md): Semantic Conventions for database client *spans*.
41-
* [DB Metrics](database-metrics.md): Semantic Conventions for database operation *metrics*.
40+
- [DB Spans](database-spans.md): Semantic Conventions for database client *spans*.
41+
- [DB Metrics](database-metrics.md): Semantic Conventions for database operation *metrics*.
4242

4343
Technology specific semantic conventions are defined for the following databases:
4444

45-
* [AWS DynamoDB](dynamodb.md): Semantic Conventions for *AWS DynamoDB*.
46-
* [Cassandra](cassandra.md): Semantic Conventions for *Cassandra*.
47-
* [Azure Cosmos DB](cosmosdb.md): Semantic Conventions for *Azure Cosmos DB*.
48-
* [CouchDB](couchdb.md): Semantic Conventions for *CouchDB*.
49-
* [Elasticsearch](elasticsearch.md): Semantic Conventions for *Elasticsearch*.
50-
* [HBase](hbase.md): Semantic Conventions for *HBase*.
51-
* [MongoDB](mongodb.md): Semantic Conventions for *MongoDB*.
52-
* [Microsoft SQL Server](sql-server.md): Semantic Conventions for *Microsoft SQL Server*.
53-
* [Oracle Database](oracledb.md): Semantic Conventions for *Oracle Database*.
54-
* [Redis](redis.md): Semantic Conventions for *Redis*.
55-
* [SQL](sql.md): Semantic Conventions for *SQL* databases.
45+
- [AWS DynamoDB](dynamodb.md): Semantic Conventions for *AWS DynamoDB*.
46+
- [Cassandra](cassandra.md): Semantic Conventions for *Cassandra*.
47+
- [Azure Cosmos DB](cosmosdb.md): Semantic Conventions for *Azure Cosmos DB*.
48+
- [CouchDB](couchdb.md): Semantic Conventions for *CouchDB*.
49+
- [Elasticsearch](elasticsearch.md): Semantic Conventions for *Elasticsearch*.
50+
- [HBase](hbase.md): Semantic Conventions for *HBase*.
51+
- [MongoDB](mongodb.md): Semantic Conventions for *MongoDB*.
52+
- [Microsoft SQL Server](sql-server.md): Semantic Conventions for *Microsoft SQL Server*.
53+
- [Oracle Database](oracledb.md): Semantic Conventions for *Oracle Database*.
54+
- [Redis](redis.md): Semantic Conventions for *Redis*.
55+
- [SQL](sql.md): Semantic Conventions for *SQL* databases.
5656

5757
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/cassandra.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -147,13 +147,13 @@ Examples:
147147
The following attributes can be important for making sampling decisions
148148
and SHOULD be provided **at span creation time** (if provided at all):
149149

150-
* [`db.collection.name`](/docs/registry/attributes/db.md)
151-
* [`db.namespace`](/docs/registry/attributes/db.md)
152-
* [`db.operation.name`](/docs/registry/attributes/db.md)
153-
* [`db.query.summary`](/docs/registry/attributes/db.md)
154-
* [`db.query.text`](/docs/registry/attributes/db.md)
155-
* [`server.address`](/docs/registry/attributes/server.md)
156-
* [`server.port`](/docs/registry/attributes/server.md)
150+
- [`db.collection.name`](/docs/registry/attributes/db.md)
151+
- [`db.namespace`](/docs/registry/attributes/db.md)
152+
- [`db.operation.name`](/docs/registry/attributes/db.md)
153+
- [`db.query.summary`](/docs/registry/attributes/db.md)
154+
- [`db.query.text`](/docs/registry/attributes/db.md)
155+
- [`server.address`](/docs/registry/attributes/server.md)
156+
- [`server.port`](/docs/registry/attributes/server.md)
157157

158158
---
159159

0 commit comments

Comments
 (0)