Commit b18acc4
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
File tree
32 files changed
+42
-76
lines changed- cmd/mdatagen
- internal
- sampleconnector
- internal/metadata
- samplefactoryreceiver
- internal/metadata
- sampleprocessor
- samplereceiver
- internal
- metadatatest
- metadata
- samplescraper
- internal/metadata
32 files changed
+42
-76
lines changedSome generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 2 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
2 | 1 | | |
3 | 2 | | |
4 | | - | |
5 | | - | |
6 | 3 | | |
| 4 | + | |
7 | 5 | | |
8 | 6 | | |
9 | 7 | | |
| |||
Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
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