Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs section for instrumentation submodule naming convention #12893

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

jaydeluca
Copy link
Member

Resolves #2891

@jaydeluca jaydeluca requested a review from a team as a code owner December 14, 2024 15:23
@github-actions github-actions bot requested a review from theletterf December 14, 2024 15:23
@@ -68,6 +68,47 @@ include("instrumentation:yarpc-1.0:library")
include("instrumentation:yarpc-1.0:testing")
```

## Instrumentation Submodules

When writing instrumentation that requires submodules for different versions, the name of each
Copy link
Contributor

Choose a reason for hiding this comment

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

How about adding related content in Folder Structure part directly? It might look more concentrated.

Copy link
Member Author

Choose a reason for hiding this comment

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

good idea, i've made the instrumentation submodules section an H3 so it's a subsection of Folder Structure

Copy link
Contributor

@breedx-splk breedx-splk left a comment

Choose a reason for hiding this comment

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

Wow, knocking out this ancient issue! Nice.

@trask trask merged commit f7472b7 into open-telemetry:main Dec 16, 2024
56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve instrumentation folder structure doc to mention multi-version structure
4 participants