open-telemetry / open-telemetry/semantic-conventions-java

Ensure javadoc links resolve

Open
#10 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Java
Stars
39
Forks
36
Avg merge
22h 36m
Merged PRs (30d)
15

Description

The code generation produces links that are relative to the root of the semantic-conventions repo and therefore do not resolve. example here.

We should fix the code gen so that links resolve.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the code-generation path that produces src/main/java/io/opentelemetry/semconv/resource/attributes/ResourceAttributes.java and the generated Javadoc link shown in the issue. Run the generation process and verify that the resulting links resolve from the generated Java source rather than the repository root.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.