Fix Java manual instrumentation with Spring Boot app

[PerfectSlayer]

Hi OpenTelemetry team 👋

Following a dependency management issue using Java Spring Boot app and Gradle build system, I updated the Java Manual Instrumentation documentation page.

This PR proposes a fix to #3613 and the rationale for its content (using OTel BOM import rather than removing Spring dependency management pluging) is explained in my comment: open-telemetry/opentelemetry-java#6018 (comment).

It's my first contribution to this repository so feel free to provide guidance if I miss something.
I have built the site locally and tested it using npm run test. It seemed fine 😇

Note

In addition, I updated the highlight sections, fix semconv versions and restore a missing semi-column.

[svrnm]

@open-telemetry/java-approvers please take a look

[jeanbisutti]

@PerfectSlayer There are two ways to manage a BOM with Gradle and Spring Boot. Could you please also document the way with the Gradle’s native bom support (as I did on this PR for the Spring Boot page)?

[jeanbisutti]

@PerfectSlayer Could you also please add documentation on how to configure the things with Maven (as I did on #3672 for the Spring Boot page)?

[svrnm]

@open-telemetry/java-approvers PTAL

[PerfectSlayer]

@jeanbisutti Sure, I was waiting for #3672 to be reviewed first.

[PerfectSlayer]

It pushed some changes to reflect BOM documentation from @jeanbisutti
I also moved a paragraph (throughout this documentation you will add dependencies.…) from the Gradle tab below, to be accessible for Maven users too, and removed duplicated maven dependencies to stay consistent (only adding SDK on installing SDK chapter, like autoconfigure).

[cartermp]

@PerfectSlayer if you run npm run fix:format then this should be good.

[PerfectSlayer]

@cartermp I run it and amend the commit it fixed.

Oh and sorry for both typos... Pretty exhausted by the end of the year 😫

[cartermp]

@open-telemetry/java-approvers please take a look!

[PerfectSlayer]

Hey there! Happy New Year 🎉

Coming to check up on things. Is there anything I can do on my side to get this PR progress?

[trask]

we are good to go from the Java SIG side with @laurit and @jeanbisutti's approvals

[jack-berg]

Left a handful of comments that aren't necessarily related to the changes @PerfectSlayer makes, but didn't seem right to let them continue to go unnoticed.

[jack-berg]

Throughout this documentation you will add dependencies. For a full list of
artifact coordinates, see [releases].

I like this section near the top - maybe even the first line in the dependency management section. Starting with the bom feels strange without first establishing which artifacts the bom aligns.

[jack-berg]

The phrasing here is odd. Your change is fine but I wonder if we should correct it.

If you instrument a Java app, install the dependencies for the OpenTelemetry SDK

That's a really poor introduction to the SDK. Maybe something like:

"The OpenTelemetry API provides a set of interfaces for collecting telemetry, but the data is dropped without an implementation. The OpenTelemetry SDK is the implementation of the OpenTelemetry API provided by OpenTelemetry. To use it, begin by installing dependencies:"

[jack-berg]

Suggested change

implementation("io.opentelemetry:opentelemetry-api");

I believe your intent is to omit opentelemetry-api here since its included above.

[svrnm]

@PerfectSlayer can you take a look at the review comments?

[PerfectSlayer]

Sure will do this tomorrow or next week 👍

[zeitlinger]

In addition, I updated the highlight sections

what is the intention of the highlights?

[chalin]

See inline comment.

This will need to be rebased.

[PerfectSlayer]

I rebased the branch and should have taken all the review comments into account.

[jeanbisutti]

LGTM

Thanks a lot @PerfectSlayer!

It would remain the comment from Gregor: #3656 (comment) @zeitlinger, could you please elaborate a bit your question?

[svrnm]

@PerfectSlayer can you resolve the conflict?

[PerfectSlayer]

@svrnm I just did using GH Web UI.