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

Adding an "Android" entry to /docs/languages/ #6136

Open
LikeTheSalad opened this issue Jan 31, 2025 · 6 comments
Open

Adding an "Android" entry to /docs/languages/ #6136

LikeTheSalad opened this issue Jan 31, 2025 · 6 comments

Comments

@LikeTheSalad
Copy link

Desired feature or idea: Having Android listed here with a small introduction to this repo.

Additional context: This page tends to be a common way for people to discover what's supported by OTel, so even though the OTel Android project is not yet stable, having an entry there should help bring people's attention to this project and hopefully finding contributors too!

@svrnm
Copy link
Member

svrnm commented Jan 31, 2025

Hey, thanks for raising this! I have thought about the question how we want to add client site implementations to the docs in the past a few times, but never came to a point to write it down, so I take your PR as a trigger to get started with that.

I think there are 2 options:

  1. We follow the "current" pattern, where we add them to the right language. Today we have "browser" under JS (see https://opentelemetry.io/docs/languages/js/getting-started/browser/), so in that case we would add an "android" page (or pages) somewhere under java
  2. We create a top level page called "Client site instrumentation" or "Client Instrumentation" (or similar, we can find a good name), right below the Languages/Zero-Code, and there we will have Mobile, Browser, etc with the different colors and implementations.

My personal opinion is that having "languages/android" is confusing to end users, since android is not a programming language, that's why I suggest the two options above. I would prefer the prominent option (2) long term, but we can start with (1) while things are still evolving.

@open-telemetry/docs-approvers @open-telemetry/android-approvers @open-telemetry/javascript-approvers @open-telemetry/java-approvers PTAL

@trask
Copy link
Member

trask commented Jan 31, 2025

I don't personally mind having Android as a top-level language. It's a top-level SIG in OpenTelemetry, and it's a pretty distinct ecosystem from Java.

@cartermp
Copy link
Contributor

I wonder if this is the right time to move browser JS, along with Android and iOS, and perhaps k8s, into a "platform" parent node. That's increasingly how I see users/customers reason about the nature of OTel support for what they're doing.

@chalin
Copy link
Contributor

chalin commented Jan 31, 2025

FYI, that's what we ended up doing for gRPC, see https://grpc.io/docs/ which has "Languages" and "Platforms".

@svrnm
Copy link
Member

svrnm commented Feb 5, 2025

We talked about this during the SIG call yesterday, and it seems that the "Platforms"-idea is what we want to implement, i.e. we create "Platforms" as a new top level category, and it will contain:

  • Android
  • Browser
  • Kubernetes
  • FaaS
  • Other

This is similar to the grpc-page as @chalin linked to it, and seems to be commonly understood.

@open-telemetry/operator-approvers @open-telemetry/lambda-extension-approvers @open-telemetry/android-approvers @open-telemetry/sandbox-web-js-maintainers @open-telemetry/javascript-approvers PTAL!

Edit

Let's continue to track this via the following issue. Please add your likes etc on this issue:

@chalin
Copy link
Contributor

chalin commented Feb 5, 2025

Here's a first PR in support of a new Platforms section, PTAL:

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

No branches or pull requests

5 participants