Skip to content

Commit d75505d

Browse files
committed
[mdatagen] Add description field to samplefactoryreceiver
Move the description text inside the autogenerated section by adding the description field to metadata.yaml. This ensures all sample components follow the same pattern where description is generated from metadata rather than manually written outside the markers. Related to #14114
1 parent 1e78dec commit d75505d

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

cmd/mdatagen/internal/samplefactoryreceiver/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
This receiver is used for testing purposes to check the output of mdatagen.
2-
31
<!-- status autogenerated section -->
42
# Sample Factory Receiver
3+
This receiver is used for testing purposes to check the output of mdatagen.
4+
5+
56
| Status | |
67
| ------------- |-----------|
78
| Stability | [deprecated]: profiles |

cmd/mdatagen/internal/samplefactoryreceiver/metadata.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
type: sample
44
display_name: Sample Factory Receiver
5+
description: This receiver is used for testing purposes to check the output of mdatagen.
56
scope_name: go.opentelemetry.io/collector/internal/receiver/samplefactoryreceiver
67
github_project: open-telemetry/opentelemetry-collector
78

0 commit comments

Comments
 (0)