[cicd] update vcs.change.state briefs

open-telemetry · Sep 15, 2024 · afaa1f5 · afaa1f5
1 parent 347b15b
commit afaa1f5
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/docs/attributes-registry/vcs.md b/docs/attributes-registry/vcs.md
@@ -33,11 +33,11 @@ based on the VCS system and situational context.
 
 `vcs.change.state` 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.
 
-| Value    | Description                                                                                    | Stability                                                        |
-| -------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| `closed` | closed                                                                                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `merged` | [merged](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag)     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `open`   | [open](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| Value    | Description                                                                                                                                                                                                                                 | Stability                                                        |
+| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `closed` | Closed means the merge request has been closed without merging. This can happen for various reasons, such as the changes being deemed unnecessary, the issue being resolved in another way, or the author deciding to withdraw the request. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `merged` | Merged indicates that the change has been successfully integrated into the target codebase.                                                                                                                                                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `open`   | Open means the change is currently active and under review. It hasn't been merged into the target branch yet, and it's still possible to make changes or add comments.                                                                      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 `vcs.repository.ref.type` 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.
 

diff --git a/docs/cicd/cicd-metrics.md b/docs/cicd/cicd-metrics.md
@@ -68,9 +68,9 @@ but more may be added in the future.
 
 | Value  | Description | Stability |
 |---|---|---|
-| `closed` | closed | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `merged` | [merged](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `open` | [open](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `closed` | Closed means the merge request has been closed without merging. This can happen for various reasons, such as the changes being deemed unnecessary, the issue being resolved in another way, or the author deciding to withdraw the request. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `merged` | Merged indicates that the change has been successfully integrated into the target codebase. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `open` | Open means the change is currently active and under review. It hasn't been merged into the target branch yet, and it's still possible to make changes or add comments. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 

diff --git a/model/registry/vcs.yaml b/model/registry/vcs.yaml
@@ -99,15 +99,15 @@ groups:
           members:
             - id: open
               value: open
-              brief: "[open](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch)"
+              brief: "Open means the change is currently active and under review. It hasn't been merged into the target branch yet, and it's still possible to make changes or add comments."
               stability: experimental
             - id: closed
               value: closed
-              brief: "closed"
+              brief: "Closed means the merge request has been closed without merging. This can happen for various reasons, such as the changes being deemed unnecessary, the issue being resolved in another way, or the author deciding to withdraw the request."
               stability: experimental
             - id: merged
               value: merged
-              brief: "[merged](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag)"
+              brief: "Merged indicates that the change has been successfully integrated into the target codebase."
               stability: experimental
         stability: experimental
         brief: >