[editorial] Rename general section pages by dropping general from t…

…he filename (#195)

Makefile

@@ -8,7 +8,7 @@ MISSPELL = $(TOOLS_DIR)/$(MISSPELL_BINARY)
 
 # see https://github.com/open-telemetry/build-tools/releases for semconvgen updates
 # Keep links in model/README.md and .vscode/settings.json in sync!
-SEMCONVGEN_VERSION=0.18.0
+SEMCONVGEN_VERSION=0.19.0
 
 # TODO: add `yamllint` step to `all` after making sure it works on Mac.
 .PHONY: all

docs/README.md

@@ -35,8 +35,8 @@ Semantic Conventions are defined for the following areas:
 
 Semantic Conventions by signals:
 
-* [Events](general/events-general.md): Semantic Conventions for event data.
-* [Logs](general/logs-general.md): Semantic Conventions for logs data.
-* [Metrics](general/metrics-general.md): Semantic Conventions for metrics.
+* [Events](general/events.md): Semantic Conventions for event data.
+* [Logs](general/logs.md): Semantic Conventions for logs data.
+* [Metrics](general/metrics.md): Semantic Conventions for metrics.
 * [Resource](resource/README.md): Semantic Conventions for resources.
-* [Trace](general/trace-general.md): Semantic Conventions for traces and spans.
+* [Trace](general/trace.md): Semantic Conventions for traces and spans.

docs/database/database-metrics.md

@@ -29,7 +29,7 @@ and units.
 Below is a table of database client connection pool metric instruments that MUST be used by connection pool
 instrumentations:
 
-| Name                          | Instrument                 | Unit        | Unit ([UCUM](/docs/general/metrics-general.md#instrument-units)) | Description                                                                               |
+| Name                          | Instrument                 | Unit        | Unit ([UCUM](/docs/general/metrics.md#instrument-units)) | Description                                                                               |
 |-------------------------------|----------------------------|-------------|-------------------------------------------|-------------------------------------------------------------------------------------------|
 | `db.client.connections.usage` | UpDownCounter | connections | `{connection}`                           | The number of connections that are currently in state described by the `state` attribute. |
 
@@ -43,7 +43,7 @@ Instrumentation libraries for database client connection pools that collect data
 following metric instruments. Otherwise, if the instrumentation library does not collect this data, these instruments
 MUST NOT be used.
 
-| Name                                     | Instrument ([*](/docs/general/metrics-general.md#instrument-types)) | Unit         | Unit ([UCUM](/docs/general/metrics-general.md#instrument-units)) | Description                                                                                       |
+| Name                                     | Instrument ([*](/docs/general/metrics.md#instrument-types)) | Unit         | Unit ([UCUM](/docs/general/metrics.md#instrument-units)) | Description                                                                                       |
 |------------------------------------------|----------------------------------------------|--------------|-------------------------------------------|---------------------------------------------------------------------------------------------------|
 | `db.client.connections.idle.max`         | UpDownCounter                                | connections  | `{connection}`                           | The maximum number of idle open connections allowed.                                              |
 | `db.client.connections.idle.min`         | UpDownCounter                                | connections  | `{connection}`                           | The minimum number of idle open connections allowed.                                              |

docs/database/database-spans.md

@@ -65,19 +65,19 @@ Some database systems may allow a connection to switch to a different `db.user`,
 | `db.system` | string | An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers. | `other_sql` | Required |
 | `db.connection_string` | string | The connection string used to connect to the database. It is recommended to remove embedded credentials. | `Server=(localdb)\v11.0;Integrated Security=true;` | Recommended |
 | `db.user` | string | Username for accessing the database. | `readonly_user`; `reporting_user` | Recommended |
-| [`network.transport`](../general/general-attributes.md) | string | [OSI Transport Layer](https://osi-model.com/transport-layer/) or [Inter-process Communication method](https://en.wikipedia.org/wiki/Inter-process_communication). The value SHOULD be normalized to lowercase. | `tcp`; `udp` | Recommended |
-| [`network.type`](../general/general-attributes.md) | string | [OSI Network Layer](https://osi-model.com/network-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `ipv4`; `ipv6` | Recommended |
-| [`server.address`](../general/general-attributes.md) | string | Name of the database host. | `example.com` | Conditionally Required: See alternative attributes below. |
-| [`server.port`](../general/general-attributes.md) | int | Logical server port number | `80`; `8080`; `443` | Conditionally Required: [1] |
-| [`server.socket.address`](../general/general-attributes.md) | string | Physical server IP address or Unix socket address. If set from the client, should simply use the socket's peer address, and not attempt to find any actual server IP (i.e., if set from client, this may represent some proxy server instead of the logical server). | `10.5.3.2` | See below |
-| [`server.socket.port`](../general/general-attributes.md) | int | Physical server port. | `16456` | Recommended: If different than `server.port`. |
+| [`network.transport`](../general/attributes.md) | string | [OSI Transport Layer](https://osi-model.com/transport-layer/) or [Inter-process Communication method](https://en.wikipedia.org/wiki/Inter-process_communication). The value SHOULD be normalized to lowercase. | `tcp`; `udp` | Recommended |
+| [`network.type`](../general/attributes.md) | string | [OSI Network Layer](https://osi-model.com/network-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `ipv4`; `ipv6` | Recommended |
+| [`server.address`](../general/attributes.md) | string | Name of the database host. | `example.com` | Conditionally Required: See alternative attributes below. |
+| [`server.port`](../general/attributes.md) | int | Logical server port number | `80`; `8080`; `443` | Conditionally Required: [1] |
+| [`server.socket.address`](../general/attributes.md) | string | Physical server IP address or Unix socket address. If set from the client, should simply use the socket's peer address, and not attempt to find any actual server IP (i.e., if set from client, this may represent some proxy server instead of the logical server). | `10.5.3.2` | See below |
+| [`server.socket.port`](../general/attributes.md) | int | Physical server port. | `16456` | Recommended: If different than `server.port`. |
 
 **[1]:** If using a port other than the default port for this DBMS and if `server.address` is set.
 
 **Additional attribute requirements:** At least one of the following sets of attributes is required:
 
-* [`server.address`](../general/general-attributes.md)
-* [`server.socket.address`](../general/general-attributes.md)
+* [`server.address`](../general/attributes.md)
+* [`server.socket.address`](../general/attributes.md)
 
 `db.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
 

docs/database/elasticsearch.md

@@ -40,8 +40,8 @@ in order to map the path part values to their names.
 | [`db.operation`](database-spans.md) | string | The endpoint identifier for the request. [1] | `search`; `ml.close_job`; `cat.aliases` | Required |
 | [`db.statement`](database-spans.md) | string | The request body for a [search-type query](https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html), as a json string. | `"{\"query\":{\"term\":{\"user.id\":\"kimchy\"}}}"` | Recommended: [2] |
 | `http.request.method` | string | HTTP request method. [3] | `GET`; `POST`; `HEAD` | Required |
-| [`server.address`](../general/general-attributes.md) | string | Logical server hostname, matches server FQDN if available, and IP or socket address if FQDN is not known. | `example.com` | See below |
-| [`server.port`](../general/general-attributes.md) | int | Logical server port number | `80`; `8080`; `443` | Recommended |
+| [`server.address`](../general/attributes.md) | string | Logical server hostname, matches server FQDN if available, and IP or socket address if FQDN is not known. | `example.com` | See below |
+| [`server.port`](../general/attributes.md) | int | Logical server port number | `80`; `8080`; `443` | Recommended |
 | [`url.full`](../url/url.md) | string | Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [4] | `https://localhost:9200/index/_search?q=user.id:kimchy` | Required |
 
 **[1]:** When setting this to an SQL keyword, it is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if the operation name is provided by the library being instrumented. If the SQL statement has an ambiguous operation, or performs more than one operation, this value may be omitted.

docs/faas/faas-metrics.md

@@ -36,7 +36,7 @@ type and units.
 
 Below is a table of FaaS invocation metric instruments.
 
-| Name                   | Instrument Type ([*](/docs/general/metrics-general.md#instrument-types)) | Unit         | Unit ([UCUM](/docs/general/metrics-general.md#instrument-units)) | Description                                                                  |
+| Name                   | Instrument Type ([*](/docs/general/metrics.md#instrument-types)) | Unit         | Unit ([UCUM](/docs/general/metrics.md#instrument-units)) | Description                                                                  |
 |------------------------|---------------------------------------------------|--------------|-------------------------------------------|------------------------------------------------------------------------------|
 | `faas.invoke_duration` | Histogram                                         | milliseconds | `ms`                                      | Measures the duration of the invocation                                      |
 | `faas.init_duration`   | Histogram                                         | milliseconds | `ms`                                      | Measures the duration of the function's initialization, such as a cold start |
@@ -47,7 +47,7 @@ Below is a table of FaaS invocation metric instruments.
 
 Optionally, when applicable:
 
-| Name             | Instrument Type ([*](/docs/general/metrics-general.md#instrument-types)) | Unit         | Unit ([UCUM](/docs/general/metrics-general.md#instrument-units)) | Description                                     |
+| Name             | Instrument Type ([*](/docs/general/metrics.md#instrument-types)) | Unit         | Unit ([UCUM](/docs/general/metrics.md#instrument-units)) | Description                                     |
 |------------------|---------------------------------------------------|--------------|-------------------------------------------|-------------------------------------------------|
 | `faas.mem_usage` | Histogram                                         | Bytes        | `By`                                      | Distribution of max memory usage per invocation |
 | `faas.cpu_usage` | Histogram                                         | milliseconds | `ms`                                      | Distribution of CPU usage per invocation        |

docs/general/README.md

@@ -12,11 +12,11 @@ This document defines general Semantic Conventions for spans, metrics, logs and
 
 The following general Semantic Conventions are defined:
 
-* **[General attributes](general-attributes.md): General semantic attributes**.
-* [Events](events-general.md): General Semantic Conventions for events.
-* [Logs](logs-general.md): General Semantic Conventions for logs.
-* [Metrics](metrics-general.md): General Semantic Conventions for metrics.
-* [Spans](trace-general.md): General Semantic Conventions for traces / spans.
+* **[General attributes](attributes.md): General semantic attributes**.
+* [Events](events.md): General Semantic Conventions for events.
+* [Logs](logs.md): General Semantic Conventions for logs.
+* [Metrics](metrics.md): General Semantic Conventions for metrics.
+* [Spans](trace.md): General Semantic Conventions for traces / spans.
 
 ## Event Name Reuse Prohibition
 

docs/general/general-attributes.md → docs/general/attributes.md

@@ -1,5 +1,6 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Attributes
+aliases: [docs/specs/semconv/general/general-attributes]
 --->
 
 # General Attributes

docs/general/events-general.md → docs/general/events.md

@@ -1,5 +1,6 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Events
+aliases: [docs/specs/semconv/general/events-general]
 --->
 
 # Semantic Conventions for Event Attributes

docs/general/logs-general.md → docs/general/logs.md

@@ -1,5 +1,6 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Logs
+aliases: [docs/specs/semconv/general/logs-general]
 --->
 
 # General Logs Attributes
@@ -26,7 +27,7 @@ The following semantic conventions for logs are defined:
 * [Exceptions](/docs/exceptions/exceptions-logs.md): Semantic attributes that may be used in describing exceptions in logs.
 * [Feature Flags](/docs/feature-flags/feature-flags-logs.md): Semantic attributes that may be used in describing feature flag evaluations in logs.
 
-Apart from semantic conventions for logs, [events](events-general.md), [traces](trace-general.md), and [metrics](metrics-general.md),
+Apart from semantic conventions for logs, [events](events.md), [traces](trace.md), and [metrics](metrics.md),
 OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/resource/sdk.md) with their own
 [Resource Semantic Conventions](/docs/resource/README.md).
 

docs/general/metrics-general.md → docs/general/metrics.md

@@ -1,5 +1,6 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Metrics
+aliases: [docs/specs/semconv/general/metrics-general]
 --->
 
 # Metrics Semantic Conventions
@@ -34,7 +35,7 @@ The following semantic conventions surrounding metrics are defined:
   * [Process](/docs/system/process-metrics.md): For standard process metrics.
   * [Runtime Environment](/docs/system/runtime-environment-metrics.md): For runtime environment metrics.
 
-Apart from semantic conventions for metrics, [traces](trace-general.md), [logs](logs-general.md), and [events](events-general.md), OpenTelemetry also
+Apart from semantic conventions for metrics, [traces](trace.md), [logs](logs.md), and [events](events.md), OpenTelemetry also
 defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/resource/sdk.md) with
 their own [Resource Semantic Conventions](/docs/resource/README.md).
 

docs/general/trace-general.md → docs/general/trace.md

@@ -1,5 +1,6 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Trace
+aliases: [docs/specs/semconv/general/trace-general]
 --->
 
 # Trace Semantic Conventions
@@ -19,7 +20,7 @@ can still be easily correlated and cross-analyzed.
 
 The following semantic conventions for spans are defined:
 
-* **[General](general-attributes.md): General semantic attributes that may be used in describing different kinds of operations.**
+* **[General](attributes.md): General semantic attributes that may be used in describing different kinds of operations.**
 * [Compatibility](trace-compatibility.md): For spans generated by compatibility components, e.g. OpenTracing Shim layer.
 * [CloudEvents](/docs/cloudevents/README.md): Semantic Conventions for the CloudEvents spans.
 * [Cloud Providers](/docs/cloud-providers/README.md): Semantic Conventions for cloud providers spans.
@@ -32,7 +33,7 @@ The following semantic conventions for spans are defined:
 * [Object Stores](/docs/object-stores/README.md): Semantic Conventions for object stores spans.
 * [RPC/RMI](/docs/rpc/rpc-spans.md): For remote procedure call (e.g., gRPC) spans.
 
-Apart from semantic conventions for traces, [metrics](metrics-general.md), [logs](logs-general.md), and [events](events-general.md),
+Apart from semantic conventions for traces, [metrics](metrics.md), [logs](logs.md), and [events](events.md),
 OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/resource/sdk.md) with their own
 [Resource Semantic Conventions](/docs/resource/README.md).