open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
565 stars 1.22k forks source link

Spring Boot Starter: adjust "OpenTelemetry starter" terminology #4567

Open chalin opened 5 months ago

chalin commented 5 months ago

Originally posted by @jeanbisutti in https://github.com/open-telemetry/opentelemetry.io/issues/4563#issuecomment-2141257204

Spring Boot provides the possibilty to create starters: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.starters

The full name would be "OpenTelemetry Spring Boot starter". "OpenTelemetry starter" is shorter and could be understood as a "Spring Boot starter" in the context of Spring Boot applications.

jeanbisutti commented 5 months ago

A proposition

  1. Leave "Spring Boot starter" in the menu and the index page. We have "Agent" for the OpenTelemetry Java agent. This gives the technology used.
  2. Leave "OpenTelemetry Spring Boot starter" in the index page which makes things very clear.
  3. Use "OpenTelemetry starter" in the pages outside the index.

image

cc @zeitlinger

svrnm commented 5 months ago

Following up on this a few notes: