Fix dead benchmarks link in documentation#4238
Conversation
|
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>
df4fa10 to
fab727d
Compare
|
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? |
|
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! |
|
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:
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! |
|
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:
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! |
|
@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
left a comment
There was a problem hiding this comment.
Thank you @rohansood10 ! Lgtm; the Maintainers are needed for this to be merged.
Fixes #4163
The benchmarks page at
https://open-telemetry.github.io/opentelemetry-python-contrib/benchmarks/index.htmlreturns a 404. The entire GitHub Pages site appears to be down.This updates
docs/performance/benchmarks.rstto point users to the in-repo benchmark directories instead of the dead external link.