docs: fix broken source links in instrumentation guides - #12267
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 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".
| from [multiple](https://github.com/DataDog/dd-trace-java/blob/5307b46fe3956f0d1f09f84e1dab580af222ddc5/dd-java-agent/instrumentation/google-http-client-1.19/src/main/java/datadog/trace/instrumentation/googlehttpclient/GoogleHttpClientInstrumentation.java#L75) | ||
| different [places](https://github.com/DataDog/dd-trace-java/blob/5307b46fe3956f0d1f09f84e1dab580af222ddc5/dd-java-agent/instrumentation/google-http-client-1.19/src/main/java/datadog/trace/instrumentation/googlehttpclient/GoogleHttpClientInstrumentation.java#L103) |
There was a problem hiding this comment.
When a reader follows either link, GitHub resolves the path within the fixed 5307b46... snapshot rather than the current tree. That snapshot predates the module's move to google-http-client-1.19, so changing only the directory while retaining the old SHA makes both URLs return 404. Keep the original google-http-client path for this SHA, or update the SHA and line anchors together.
Useful? React with 👍 / 👎.
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.
7319b53 to
6b54631
Compare
2 participants
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 indocs/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.mdandhow_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 stillgoogle-http-client. I verified both against raw.githubusercontent at that SHA:.../instrumentation/google-http-client/....../instrumentation/google-http-client-1.19/...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.