Skip to content

docs: fix broken relative links in experimental docs - #7046

Open
mihhhir08 wants to merge 3 commits into
open-telemetry:mainfrom
mihhhir08:fix-broken-doc-links
Open

docs: fix broken relative links in experimental docs#7046
mihhhir08 wants to merge 3 commits into
open-telemetry:mainfrom
mihhhir08:fix-broken-doc-links

Conversation

@mihhhir08

Copy link
Copy Markdown

Found three relative links in the experimental docs that point at files that don't exist.

The experimental CHANGELOG links to doc/upgrade-to-2.x.md, but the upgrade guide is at the repo root, so from experimental/ it needs to be ../doc/upgrade-to-2.x.md.

The sdk-logs README links to ./src/config.ts, which isn't there anymore. The default LoggerConfig now lives in ./src/config/LoggerConfigurators.ts so I pointed it there.

The exporter-trace-otlp-grpc README links to ./test/certs/regenerate.sh, but that package has no test/certs directory. The script is in otlp-grpc-exporter-base, which that package already depends on.

Docs only, no code changed, so I think this one needs the Skip Changelog label. markdownlint-cli2 passes on all three files.

One thing I wasn't sure about, on the sdk-logs link you might prefer pointing at src/internal/LoggerProviderSharedState.ts since that also defines a DEFAULT_LOGGER_CONFIG. Happy to switch it if that reads better.

Three relative links in the experimental docs pointed at paths that do not
exist:

- experimental/CHANGELOG.md linked to doc/upgrade-to-2.x.md, but the upgrade
  guide lives at the repository root, so from experimental/ it needs ../.
- sdk-logs/README.md linked to ./src/config.ts, which no longer exists. The
  default LoggerConfig is now defined in ./src/config/LoggerConfigurators.ts.
- exporter-trace-otlp-grpc/README.md linked to ./test/certs/regenerate.sh,
  but that package has no test/certs directory. The script lives in
  otlp-grpc-exporter-base, which the package already depends on.

Signed-off-by: Mihirsinh Chavda <mihhhir08@gmail.com>
@mihhhir08
mihhhir08 requested a review from a team as a code owner August 31, 2026 15:57
@linux-foundation-easycla

linux-foundation-easycla Bot commented Aug 31, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

@github-actions

Copy link
Copy Markdown

Welcome, contributor! Thank you for your contribution to opentelemetry-js.

Important reminders:

@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Aug 31, 2026

Copy link
Copy Markdown

Pull request dashboard status

Waiting on maintainers · refreshed 2026-09-08 08:38 UTC

Merge when ready.

Status above doesn't look right?
  • Just replied or pushed? Anything around or after the refresh time above may not be picked up yet — give it a few minutes.
  • Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

Comment thread experimental/packages/sdk-logs/README.md Outdated
…ved file

Assisted-by: Claude Opus 5

Signed-off-by: Mihirsinh Chavda <mihhhir08@gmail.com>
@mihhhir08
mihhhir08 force-pushed the fix-broken-doc-links branch from ab064f7 to 7ab9ab6 Compare September 5, 2026 03:21
@codecov

codecov Bot commented Sep 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.97%. Comparing base (b68078d) to head (13dbbe2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7046   +/-   ##
=======================================
  Coverage   94.97%   94.97%           
=======================================
  Files         406      406           
  Lines       14269    14269           
  Branches     3272     3272           
=======================================
  Hits        13552    13552           
  Misses        717      717           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pichlermarc
pichlermarc added this pull request to the merge queue Sep 7, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch Sep 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants