improve descriptions

Signed-off-by: ChrsMark <[email protected]>

.chloggen/merge_cpu_states.yaml

@@ -10,7 +10,7 @@ change_type: breaking
 component: system
 
 # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
-note: Merge *.cpu.state attributes into a common cpu.state attribute
+note: Rename `process.cpu.state`, `container.cpu.state`, and `system.cpu.state` attributes into a common `cpu.state` attribute
 
 # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
 # The values here must be integers.

model/registry/cpu.yaml

@@ -2,8 +2,7 @@ groups:
   - id: registry.cpu
     prefix: cpu
     type: attribute_group
-    brief: >
-      A cpu instance
+    brief: Attributes specific to a cpu instance.
     attributes:
       - id: state
         brief: "The state of the CPU"

model/registry/deprecated/container.yaml

@@ -10,7 +10,7 @@ groups:
         stability: experimental
         deprecated: "Replaced by `container.label`."
       - id: container.cpu.state
-        brief: "The CPU state for this data point."
+        brief: "Deprecated, use `cpu.state` instead."
         type:
           allow_custom_values: true
           members:
@@ -28,4 +28,4 @@ groups:
               stability: experimental
         stability: experimental
         deprecated: 'Removed, report cpu state with `cpu.state` common attribute'
-        examples: [ "user", "kernel" ]
+        examples: [ "user", "kernel" ]

model/registry/deprecated/process.yaml

@@ -4,8 +4,7 @@ groups:
     brief: "Deprecated process attributes."
     attributes:
       - id: process.cpu.state
-        brief: >
-          The CPU state of the process.
+        brief: "Deprecated, use `cpu.state` instead."
         deprecated: 'Removed, report cpu state with `cpu.state` common attribute'
         type:
           allow_custom_values: true

model/registry/deprecated/system.yaml

@@ -48,7 +48,7 @@ groups:
             - id: steal
               value: 'steal'
               stability: experimental
-        brief: "The state of the CPU"
+        brief: "Deprecated, use `cpu.state` instead."
         stability: experimental
         deprecated: 'Removed, report cpu state with `cpu.state` common attribute'
         examples: [ "idle", "interrupt" ]