Skip to content

Conversation

@aaajhs
Copy link
Contributor

@aaajhs aaajhs commented Jul 17, 2024

Fixes #34139

@aaajhs aaajhs requested a review from dashpole as a code owner July 17, 2024 19:13
@aaajhs aaajhs requested a review from a team July 17, 2024 19:13
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 17, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: aaajhs / name: Danny Jang (73070de)

@github-actions github-actions bot added the processor/resourcedetection Resource detection processor label Jul 17, 2024
@github-actions github-actions bot requested a review from Aneurysm9 July 17, 2024 19:14
Copy link
Member

@songy23 songy23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign the CLA

@aaajhs aaajhs force-pushed the fix/eks-config-example branch from 94663a6 to 421df2d Compare July 17, 2024 19:46
@aaajhs
Copy link
Contributor Author

aaajhs commented Jul 17, 2024

@songy23 Done

@aaajhs aaajhs requested a review from songy23 July 17, 2024 19:51
Copy link
Member

@songy23 songy23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@songy23 songy23 added documentation Improvements or additions to documentation Skip Changelog PRs that do not require a CHANGELOG.md entry labels Jul 17, 2024
@aaajhs aaajhs force-pushed the fix/eks-config-example branch from 421df2d to 73070de Compare July 17, 2024 21:07
@songy23 songy23 added the ready to merge Code review completed; ready to merge by maintainers label Jul 19, 2024
Copy link
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While adding this example is indeed useful I think the motivation for it surfaces a more generic issue. That has to do with how intuitive and useful is the current format of the attributes' documentation. Users reading the main README.md have to head to the metadata.yaml files to look for more precise "documentation". Not all users might be familiar with this though.
Maybe having an autogenerated .md file listing all the attributes like how it's done in the receivers' docs would be useful?

@codeboten
Copy link
Contributor

While adding this example is indeed useful I think the motivation for it surfaces a more generic issue. That has to do with how intuitive and useful is the current format of the attributes' documentation. Users reading the main README.md have to head to the metadata.yaml files to look for more precise "documentation". Not all users might be familiar with this though. Maybe having an autogenerated .md file listing all the attributes like how it's done in the receivers' docs would be useful?

@ChrsMark I agree, can you open an issue to add this mdatagen?

@codeboten codeboten merged commit 8ec1b51 into open-telemetry:main Jul 22, 2024
@github-actions github-actions bot added this to the next release milestone Jul 22, 2024
@aaajhs aaajhs deleted the fix/eks-config-example branch July 22, 2024 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation processor/resourcedetection Resource detection processor ready to merge Code review completed; ready to merge by maintainers Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation missing example config for enabling k8s.cluster.name in EKS

6 participants