Add Intro to OpenTelemetry Java page #5471
Conversation
There was a problem hiding this comment.
I broke this content out to a page but it could just as easily live in _index.md. The advantage of a dedicated page is that its easier to find in the nav. It might not always be intuitive that "Java" is itself a page, instead of just a button to expand / contract children.
| Click the link in the "Managed Dependencies" column to see a list of the | ||
| artifacts managed by the BOM. | ||
|
|
||
| | Description | Repository | Group ID | Artifact ID | Current Version | Managed Dependencies | |
There was a problem hiding this comment.
The "Managed Dependencies" column of this table is awesome. It links to the current version of each BOM's pom.xml, allowing the user to see the list of managed dependencies at a glance, guaranteed to be up to date.
| different use cases, listed below in order of increasing scope. We highly | ||
| recommend using a BOM. Because the BOMs are hierarchical, adding dependencies on | ||
| multiple BOMs is not recommended, as it is redundant and can lead unintuitive | ||
| dependency version resolution. |
There was a problem hiding this comment.
adding dependencies on multiple BOMs is not recommended
This is a new an important piece of advice. Choose your BOM wisely!
| @@ -14,74 +14,3 @@ weight: 18 | |||
| --- | |||
|
|
|||
| {{% docs/languages/index-intro java /%}} | |||
|
|
|||
There was a problem hiding this comment.
All this content moves to intro.md.
|
Ping @open-telemetry/docs-maintainers. I think this is good to merge. |
Part of #5211.
Add new "Intro to OpenTelemetry Java" page, introducing key aspects of the OpenTelemetry Java ecosystem and establishing basic vocabulary to help route users to the right pages for additional details.
Preview available here: https://deploy-preview-5471--opentelemetry.netlify.app/docs/languages/java/intro/