Skip to content

Commit b18acc4

Browse files
thc1006steveyiyo
andcommitted
Address review feedback: make display_name replace title
This commit addresses @codeboten's review feedback on PR open-telemetry#14115. The display_name field now properly replaces the title in generated README files instead of creating duplicate headings. Changes: - Update test metadata.yaml files with appropriate display_name values - Clean up README files to remove duplicate titles - Regenerate README files with display_name as the sole H1 heading The README structure is now: - Description text - <!-- status autogenerated section --> - # Component Display Name (from display_name field) - Status table - <!-- end autogenerated section --> Fixes the issue where multiple H1 headings appeared when display_name was set, which was confusing and not the intended behavior. Co-authored-by: SteveYi <[email protected]>
1 parent 17f964d commit b18acc4

32 files changed

+42
-76
lines changed

cmd/mdatagen/generated_package_test.go

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/sampleconnector/generated_component_test.go

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/sampleconnector/generated_package_test.go

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/sampleconnector/internal/metadata/generated_metrics.go

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/sampleconnector/internal/metadata/generated_metrics_test.go

Lines changed: 2 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/samplefactoryreceiver/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
# Sample Receiver
21
This receiver is used for testing purposes to check the output of mdatagen.
32

4-
# Sample
5-
63
<!-- status autogenerated section -->
4+
# Sample Factory Receiver
75
| Status | |
86
| ------------- |-----------|
97
| Stability | [deprecated]: profiles |

cmd/mdatagen/internal/samplefactoryreceiver/generated_component_test.go

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/samplefactoryreceiver/generated_package_test.go

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/samplefactoryreceiver/internal/metadata/generated_logs.go

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/samplefactoryreceiver/internal/metadata/generated_logs_test.go

Lines changed: 4 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)