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

No documentation on artifact names (or it is not easy to find) #3632

Closed
Oberon00 opened this issue Sep 17, 2021 · 2 comments · Fixed by #3710
Closed

No documentation on artifact names (or it is not easy to find) #3632

Oberon00 opened this issue Sep 17, 2021 · 2 comments · Fixed by #3710

Comments

@Oberon00
Copy link
Member

Slightly related to #3603, it is not obvious what artifacts one needs to depend on when using certain packages.
The readme documents

dependencies {
  implementation platform("io.opentelemetry:opentelemetry-bom:1.6.0")
  implementation('io.opentelemetry:opentelemetry-api')
}

But what do I need for https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure for example? I think it's opentelemetry-sdk-extension-autoconfigure (with singular "extension") but I only know that because I worked on #3603...

If there is any documentation on this, it should be linked more prominently in the README, e.g. the (incomplete) table at https://github.com/open-telemetry/opentelemetry-java#releases would be a good place to add artifact IDs to.

@jkwatson
Copy link
Contributor

Agreed. I usually look at the bom for this but we should have better documentation. Can you write some for us, @Oberon00 ?

@Oberon00
Copy link
Member Author

Linking to the BOM content may actually be a good "workaround", I didn't think of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants