[outreachy] Registry: add more quick installations to the registry

svrnm commented 13 hours ago

Outreachy task for @mercybassey

Based on your user experience report, please provide the following suggested improvement via a PR:

[...] an audit should be carried out to know the instrumentation libraries and collectors with missing quick install code snippets. After these audits are made, quick install code snippets should be included as part of their documentation on the OpenTelemetry registry site.

For the audit focus on component type "instrumentation" (https://opentelemetry.io/ecosystem/registry/?component=instrumentation) and core languages (C++, .NET, Erlang/Elixir, Go, Java, JavaScript, PHP, Python, Ruby, Rust, Swift). In a comment to this issue write down which languages provide quick installation, and which ones are missing. We will then identify those which can be added and we will ask you to create a PR for them.

Note: This is an assigned issue for a participant that has completed the user experience report, if you are an outreachy participant as well, find instructions here: #5290

mercybassey commented 11 hours ago

@svrnm Ruby and Rust provide quick installation for all their libraries. C++, Java, Python, and Swift don’t provide quick installation at all. .Net, Elixir, Erlang, Go, JavaScript and PHP provide quick installation for only some of their libraries. Thank you.

svrnm commented 8 hours ago

Thank you @mercybassey, let's do Java:

We want to add instructions to okHTTP Instrumentation as example, see https://opentelemetry.io/ecosystem/registry/?language=java&component=instrumentation&s=okhttp and https://github.com/open-telemetry/opentelemetry.io/blob/main/data/registry/instrumentation-java-okhttp.yml
Add a "package" section to the YML file, you can learn from other packages how to do that, pick "maven" as registry and pick the version from https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-okhttp-3.0
Take a look how it is implemented for other languages in entry.html and quickinstall
What we want to show endusers is the "Apache Maven" snippet as you can see it here https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-okhttp-3.0

open-telemetry / opentelemetry.io

[outreachy] Registry: add more quick installations to the registry #5308