Skip to content

Commit cbc9a6d

Browse files
committed
[chore] [mdatagen] Update entities terminology in generated docs
Updates mdatagen documentation template to use "Identifying Attributes" and "Descriptive Attributes" terminology (instead of "Identity Attributes" and "Description Attributes") when documenting entities. This aligns the generated documentation with OpenTelemetry specification terminology for attributes in entity context, as clarified in open-telemetry/opentelemetry-specification#4700
1 parent 2e5bb6d commit cbc9a6d

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

cmd/mdatagen/internal/sampleconnector/documentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ A test entity.
124124
125125
**Stability:** stable
126126
127-
**Identity Attributes:**
127+
**Identifying Attributes:**
128128
- `string.resource.attr`
129129

130-
**Description Attributes:**
130+
**Descriptive Attributes:**
131131
- `map.resource.attr`

cmd/mdatagen/internal/templates/documentation.md.tmpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,15 +233,15 @@ The following entities are defined for this component:
233233

234234
{{- if $entity.Identity }}
235235

236-
**Identity Attributes:**
236+
**Identifying Attributes:**
237237
{{- range $entity.Identity }}
238238
- `{{ .Ref }}`
239239
{{- end }}
240240
{{- end }}
241241

242242
{{- if $entity.Description }}
243243

244-
**Description Attributes:**
244+
**Descriptive Attributes:**
245245
{{- range $entity.Description }}
246246
- `{{ .Ref }}`
247247
{{- end }}

0 commit comments

Comments
 (0)