Skip to content

docs: fix broken source links in instrumentation guides - #12267

Closed
vaibhav8a wants to merge 1 commit into
DataDog:masterfrom
vaibhav8a:fix-broken-doc-links
Closed

docs: fix broken source links in instrumentation guides#12267
vaibhav8a wants to merge 1 commit into
DataDog:masterfrom
vaibhav8a:fix-broken-doc-links

Conversation

@vaibhav8a

@vaibhav8a vaibhav8a commented Aug 23, 2026

Copy link
Copy Markdown

Fixes links in the instrumentation guides that point at paths which no longer exist. Verified against the current tree on master.

Current-tree links corrected

  • dd-java-agent/instrumentation/google-http-client/google-http-client-1.19/ (the module directory carries the version suffix) — 4 links in docs/add_new_instrumentation.md, including the bare directory link on line 4.
  • dd-java-agent/testing/dd-java-agent/instrumentation-testing/ for the shared test base classes — add_new_instrumentation.md and how_instrumentations_work.md.

Pinned-SHA links deliberately NOT changed

Lines 191–192 link into the fixed snapshot 5307b46fe3956f0d1f09f84e1dab580af222ddc5. That commit predates the rename, so the correct path there is still google-http-client. I verified both against raw.githubusercontent at that SHA:

path @ 5307b46 result
.../instrumentation/google-http-client/... 200
.../instrumentation/google-http-client-1.19/... 404

My first revision wrongly rewrote those two as well, which would have broken them. Thanks to the review bot for catching it — now reverted, so historical links resolve inside their snapshot and current-tree links resolve on master.

@vaibhav8a
vaibhav8a requested a review from a team as a code owner August 23, 2026 16:49
@vaibhav8a
vaibhav8a requested review from mhlidd and removed request for a team August 23, 2026 16:49

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7319b5358d

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread docs/add_new_instrumentation.md Outdated
@PerfectSlayer PerfectSlayer added the tag: community Community contribution label Aug 24, 2026
Current-tree links: google-http-client -> google-http-client-1.19, and
dd-java-agent/testing -> dd-java-agent/instrumentation-testing.

Pinned-SHA links at 5307b46 are deliberately left on the old path,
since that snapshot predates the module rename.
@mhlidd

mhlidd commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

👋 Hey @vaibhav8a, thanks for the fix and contribution! I've mirrored this PR in #12399 and will merge it in ASAP. 🙇

@mhlidd mhlidd closed this Sep 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tag: community Community contribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants