[mdatagen] Generate documentation for components with resource attributes only #11242
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #11242 +/- ##
==========================================
+ Coverage 91.52% 91.54% +0.01%
==========================================
Files 428 431 +3
Lines 20233 20320 +87
==========================================
+ Hits 18519 18602 +83
- Misses 1339 1342 +3
- Partials 375 376 +1 ☔ View full report in Codecov by Sentry. |
ChrsMark
force-pushed
the
metagen_resource_attrs_only_doc
branch
from
a5fa160
to
cc2566e
Compare
ChrsMark
force-pushed
the
metagen_resource_attrs_only_doc
branch
from
cc2566e
to
fd38c70
Compare
djaglowski
approved these changes
Sep 30, 2024
ChrsMark
force-pushed
the
metagen_resource_attrs_only_doc
branch
5 times, most recently
from
f770453
to
ad21e5c
Compare
|
needs |
ChrsMark
force-pushed
the
metagen_resource_attrs_only_doc
branch
3 times, most recently
from
ea1c14d
to
47b8d38
Compare
…utes only Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
ChrsMark
force-pushed
the
metagen_resource_attrs_only_doc
branch
from
47b8d38
to
8f82a06
Compare
|
@mx-psi it should be fixed now |
mx-psi
approved these changes
Oct 4, 2024
jackgopack4
pushed a commit
to jackgopack4/opentelemetry-collector
that referenced
this pull request
Oct 8, 2024
…utes only (open-telemetry#11242) <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description This PR adds support for generating `documentation.md` files for components which only define resource attributes. This was reported at open-telemetry#10705 and also applies at open-telemetry/opentelemetry-collector-contrib#34210. <!-- Issue number if applicable --> #### Link to tracking issue Fixes open-telemetry#10705 <!--Describe what testing was performed and which tests were added.--> #### Testing Tuned tests and added a sample processor component which only defines resource attributes. <!--Describe the documentation added.--> #### Documentation <!--Please delete paragraphs that you did not use before submitting.--> Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds support for generating
documentation.mdfiles for components which only define resource attributes.This was reported at #10705 and also applies at open-telemetry/opentelemetry-collector-contrib#34210.
Link to tracking issue
Fixes #10705
Testing
Tuned tests and added a sample processor component which only defines resource attributes.
Documentation