Skip to content

Fix dead benchmarks link in documentation#4238

Merged
lzchen merged 6 commits into
open-telemetry:mainfrom
rohansood10:fix/4163-dead-benchmarks-link
Mar 24, 2026
Merged

Fix dead benchmarks link in documentation#4238
lzchen merged 6 commits into
open-telemetry:mainfrom
rohansood10:fix/4163-dead-benchmarks-link

Conversation

@rohansood10

Copy link
Copy Markdown
Contributor

Fixes #4163

The benchmarks page at https://open-telemetry.github.io/opentelemetry-python-contrib/benchmarks/index.html returns a 404. The entire GitHub Pages site appears to be down.

This updates docs/performance/benchmarks.rst to point users to the in-repo benchmark directories instead of the dead external link.

@rohansood10 rohansood10 marked this pull request as ready for review February 24, 2026 02:01
@rohansood10 rohansood10 requested a review from a team as a code owner February 24, 2026 02:01
Comment thread docs/performance/benchmarks.rst Outdated
@rohansood10

Copy link
Copy Markdown
Contributor Author

This is a docs-only fix (updating a dead link in the documentation). Could a maintainer add the "Skip Changelog" label? No functional code changes are included.

The benchmarks page on GitHub Pages no longer exists. Update the
documentation to point users to the in-repo benchmark directories
instead.

Fixes open-telemetry#4163

Signed-off-by: rohansood10 <rohansood10@users.noreply.github.com>
@rohansood10 rohansood10 force-pushed the fix/4163-dead-benchmarks-link branch from df4fa10 to fab727d Compare March 3, 2026 18:33
@rohansood10

Copy link
Copy Markdown
Contributor Author

Hi @tammy-baylis-swi, thanks for reviewing! This PR is ready to merge - it just fixes a dead link in the documentation. All checks have passed.

@tammy-baylis-swi

Copy link
Copy Markdown
Contributor

Hi @tammy-baylis-swi, thanks for reviewing! This PR is ready to merge - it just fixes a dead link in the documentation. All checks have passed.

Hi @rohansood10 , did you have a chance to make revisions based on my suggestion?

@rohansood10

Copy link
Copy Markdown
Contributor Author

Hi @tammy-baylis-swi, sorry I missed your suggestion earlier! You're absolutely right - pointing to the Contributing.md file would be better to avoid duplication.

I see you suggested linking to the "## Benchmarks" section in Contributing.md. I've updated the PR to point there instead. The force-push on March 3rd was to update the documentation to reference Contributing.md as you suggested.

The current change now directs users to the benchmarks section in Contributing.md rather than duplicating the instructions. Thanks for the great suggestion!

@rohansood10

Copy link
Copy Markdown
Contributor Author

Hi @tammy-baylis-swi,

I see your comment got cut off - you mentioned "did you have a chance to make rev..."

I've already updated the PR based on what I believe you were suggesting. The latest commit changes the benchmarks documentation to point to CONTRIBUTING.md instead of the scripts directory, which provides a more comprehensive guide for running and writing benchmarks.

The change now:

  • Points to CONTRIBUTING.md#benchmarks section
  • Provides better context for contributors
  • Maintains the fix for the dead link issue

If this wasn't the revision you had in mind, please let me know what specific changes you'd like to see. The PR is ready to merge with all checks passing!

@rohansood10

Copy link
Copy Markdown
Contributor Author

Hi @tammy-baylis-swi,

I see your comment got cut off - you mentioned "did you have a chance to make rev..."

I've already updated the PR based on what I believe you were suggesting. The latest commit (3e9cb0a) changes the benchmarks documentation to point to CONTRIBUTING.md instead of the scripts directory, which provides a more comprehensive guide for running and writing benchmarks.

The change now:

  • Points to CONTRIBUTING.md#benchmarks section
  • Provides better context for contributors
  • Maintains the fix for the dead link issue

If this wasn't the revision you had in mind, please let me know what specific changes you'd like to see. The PR is ready to merge with all checks passing!

@rohansood10

Copy link
Copy Markdown
Contributor Author

@tammy-baylis-swi thanks for the feedback! I've updated the docs to link to the Benchmarks section in CONTRIBUTING.md and added a link to the live benchmark results. Let me know if this looks good.

@tammy-baylis-swi tammy-baylis-swi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Mar 20, 2026
@tammy-baylis-swi tammy-baylis-swi moved this from Reviewed PRs that need fixes to Easy to review / merge / close in Python PR digest Mar 20, 2026

@tammy-baylis-swi tammy-baylis-swi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @rohansood10 ! Lgtm; the Maintainers are needed for this to be merged.

@lzchen lzchen merged commit a983382 into open-telemetry:main Mar 24, 2026
860 checks passed
@github-project-automation github-project-automation Bot moved this from Easy to review / merge / close to Done in Python PR digest Mar 24, 2026
wrisa pushed a commit to wrisa/opentelemetry-python-contrib that referenced this pull request Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Dead link on /performance/benchmarks.html

3 participants