Skip to content

Commit cf3dd20

Browse files
committed
Fix the documentation for deployment environment
1 parent ca4cef4 commit cf3dd20

File tree

2 files changed

+4
-7
lines changed

2 files changed

+4
-7
lines changed

docs/registry/entities/deployment.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,12 @@
1111

1212
**Description:** The software deployment.
1313

14-
> [!warning]
15-
> This entity definition contains attributes without a role.
16-
> Stable Entities MUST NOT have attributes without a defined role.
17-
1814
**Attributes:**
1915

2016
| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
2117
| --- | --- | --- | --- | --- | --- | --- |
22-
| Other | [`deployment.environment.name`](/docs/registry/attributes/deployment.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
18+
| Identity | [`deployment.name`](/docs/registry/attributes/deployment.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The name of the deployment. | `deploy my app`; `deploy-frontend` |
19+
| Description | [`deployment.environment.name`](/docs/registry/attributes/deployment.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
2320

2421
**[1] `deployment.environment.name`:** `deployment.environment.name` does not affect the uniqueness constraints defined through
2522
the `service.namespace`, `service.name` and `service.instance.id` resource attributes.

docs/resource/deployment-environment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<!-- see templates/registry/markdown/snippet.md.j2 -->
66
<!-- prettier-ignore-start -->
77

8-
**Status:** ![Stable](https://img.shields.io/badge/-stable-lightgreen)
8+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
99

1010
**type:** `deployment`
1111

@@ -16,7 +16,7 @@
1616
| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
1717
| --- | --- | --- | --- | --- | --- | --- |
1818
| Identity | [`deployment.name`](/docs/registry/attributes/deployment.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The name of the deployment. | `deploy my app`; `deploy-frontend` |
19-
| Descriptive | [`deployment.environment.name`](/docs/registry/attributes/deployment.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
19+
| Description | [`deployment.environment.name`](/docs/registry/attributes/deployment.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
2020

2121
**[1] `deployment.environment.name`:** `deployment.environment.name` does not affect the uniqueness constraints defined through
2222
the `service.namespace`, `service.name` and `service.instance.id` resource attributes.

0 commit comments

Comments
 (0)