Skip to content

Fix 404 links in .NET zero-code troubleshooting docs#9718

Merged
chalin merged 4 commits into
otelbot/refcache-refreshfrom
copilot/fix-refcache-link-errors
Apr 22, 2026
Merged

Fix 404 links in .NET zero-code troubleshooting docs#9718
chalin merged 4 commits into
otelbot/refcache-refreshfrom
copilot/fix-refcache-link-errors

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 22, 2026

Three URLs in the .NET zero-code troubleshooting page point to files removed from open-telemetry/opentelemetry-dotnet-instrumentation by PR #4783 (2026-03-30), which eliminated the DOTNET_ADDITIONAL_DEPS/DOTNET_SHARED_STORE mechanism.

Changes

  • content/en/docs/zero-code/dotnet/troubleshooting.md and content/fr/docs/zero-code/dotnet/troubleshooting.md: Replace three blob/main/... links with pinned commit-SHA URLs pointing to the last commit at which each file existed:

    • Directory.Build.props → pinned to c27acd9
    • AdditionalDeps/Directory.Packages.props → pinned to f2d70bd
    • netfx_assembly_redirection.h → pinned to 62b4a6a
  • static/refcache.json: Remove the three 404 entries for the old blob/main/... URLs so the link checker stops failing on them.

Original prompt

Context

PR #9679 (branch otelbot/refcache-refresh) is a refcache refresh PR, and its link-checking CI is failing because three URLs in the docs/zero-code/dotnet/troubleshooting/ page return HTTP 404.

The three failing URLs all point to files that were removed from open-telemetry/opentelemetry-dotnet-instrumentation on the main branch by PR open-telemetry/opentelemetry-dotnet-instrumentation#4783 (commit ad0c2dc720bab8d920de8bdbcef226596fd257b0, 2026-03-30), which eliminated the DOTNET_ADDITIONAL_DEPS/DOTNET_SHARED_STORE mechanism.

Failing URLs and their replacements

The fix is to update each URL to pin to the last commit SHA at which the file still existed:

  1. Directory.Build.props

    • Failing: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Build.props
    • Replace with: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/c27acd9bd0f82de47217fba660d9f979e0a0cc2d/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Build.props
  2. Directory.Packages.props (AdditionalDeps)

    • Failing: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Packages.props
    • Replace with: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/f2d70bd0f095852bf0270aad61b60dfe1ea7834f/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Packages.props
  3. netfx_assembly_redirection.h

    • Failing: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.Native/netfx_assembly_redirection.h
    • Replace with: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/62b4a6a855608a925caeea95752167df5a0960a0/src/OpenTelemetry.AutoInstrumentation.Native/netfx_assembly_redirection.h

Files to edit

Update the URLs in both language versions of the troubleshooting page:

  • content/en/docs/zero-code/dotnet/troubleshooting.md
  • content/fr/docs/zero-code/dotnet/troubleshooting.md

(Check for any other language versions under content/*/docs/zero-code/dotnet/troubleshooting.md that contain these same links and update them too.)

Refcache update

After updating the markdown sources, update static/refcache.json:

  • Remove the three failing URL entries (with blob/main/...) if present.
  • The new pinned URLs will be picked up naturally by the refcache refresher on next run, but if refcache entries for the pinned URLs are not already present, no action is needed — htmltest will populate them.

Acceptance criteria

  • All three failing URLs on docs/zero-code/dotnet/troubleshooting/ are replaced with the pinned commit-SHA URLs listed above, in all language variants of the file.
  • static/refcache.json no longer contains entries for the three failing blob/main/... URLs.
  • The htmltest/link-check CI job on the PR passes for these three URLs.

Base branch

Target this patch at the existing PR branch otelbot/refcache-refresh (PR #9679) so it lands in that PR.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: Link checking is failing. From this log we see the 404s:

docs/zero-code/dotnet/troubleshooting/index.html
  fresh --- docs/zero-code/dotnet/troubleshooting/index.html --> https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Build.props
  hitting --- docs/zero-code/dotnet/troubleshooting/index.html --> https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Build.props
  Non-OK status: 404 --- docs/zero-code/dotnet/troubleshooting/index.html --> https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Build.props
  fresh --- docs/zero-code/dotnet/troubleshooting/index.html --> https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Packages.props
  hitting --- docs/zero-code/dotnet/troubleshooting/index.html --> https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Packages.props
  Non-OK status: 404 --- docs/zero-code/dotnet/troubleshooting/index.html --> https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Packages.props
  fresh --- docs/zero-code/dotnet/troubleshooting/index.html --> https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/b...

</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

*This pull request was created from Copilot chat.*
>

Copilot AI changed the title [WIP] Fix broken links in troubleshooting documentation Fix 404 links in .NET zero-code troubleshooting docs Apr 22, 2026
Copilot AI requested a review from chalin April 22, 2026 11:31
@chalin
Copy link
Copy Markdown
Contributor

chalin commented Apr 22, 2026

/fix:refcache

@otelbot-docs
Copy link
Copy Markdown
Contributor

otelbot-docs Bot commented Apr 22, 2026

fix:refcache applied successfully in run 24776044256.

@otelbot-docs otelbot-docs Bot requested review from a team April 22, 2026 11:43
@otelbot-docs otelbot-docs Bot added the missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer label Apr 22, 2026
@otelbot-docs otelbot-docs Bot added the missing:sig-approval Co-owning SIG didn't provide an approval label Apr 22, 2026
@chalin chalin mentioned this pull request Apr 22, 2026
Copy link
Copy Markdown
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Only link fixes by pinning failing GH URLs to the last hash at which the given resource was valid. Approving for all SIGs and locales.

Feedback is still welcome.

Thanks @martincostello for the approval.

/cc @vitorvasc

@otelbot-docs otelbot-docs Bot added ready-to-be-merged This PR is ready to be merged by a maintainer and removed missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval labels Apr 22, 2026
@chalin chalin marked this pull request as ready for review April 22, 2026 11:50
@chalin chalin requested a review from a team as a code owner April 22, 2026 11:50
@chalin chalin merged commit c41a848 into otelbot/refcache-refresh Apr 22, 2026
22 checks passed
@chalin chalin deleted the copilot/fix-refcache-link-errors branch April 22, 2026 11:51
@chalin
Copy link
Copy Markdown
Contributor

chalin commented Apr 22, 2026

Thanks @jaydeluca for the review.

@chalin
Copy link
Copy Markdown
Contributor

chalin commented Apr 22, 2026

Btw, this is a patch PR over:

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

Labels

lang:fr ready-to-be-merged This PR is ready to be merged by a maintainer

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants