Skip to content

docs: use scm_web for auto-instrumentation and sqlcommenter examples#5428

Open
Jinsssss333 wants to merge 5 commits into
open-telemetry:mainfrom
Jinsssss333:docs-examples-scm-web-links
Open

docs: use scm_web for auto-instrumentation and sqlcommenter examples#5428
Jinsssss333 wants to merge 5 commits into
open-telemetry:mainfrom
Jinsssss333:docs-examples-scm-web-links

Conversation

@Jinsssss333

Copy link
Copy Markdown

Description

This PR replaces plain text/raw GitHub URLs under docs/examples/ with the Sphinx :scm_web: role for the auto-instrumentation and sqlcommenter examples. This ensures they are properly hyperlinked to their GitHub source files in the rendered documentation.

Fixes

Fixes #5427
hope it worked for you

@Jinsssss333
Jinsssss333 requested a review from a team as a code owner July 17, 2026 09:11
@linux-foundation-easycla

linux-foundation-easycla Bot commented Jul 17, 2026

Copy link
Copy Markdown

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

@xrmx xrmx 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.

Please reivew all the READMEs in the example dir

Comment thread docs/examples/auto-instrumentation/README.rst
@github-project-automation github-project-automation Bot moved this to Reviewed PRs that need fixes in Python PR digest Jul 17, 2026
@Jinsssss333
Jinsssss333 requested a review from xrmx July 17, 2026 11:19
@Jinsssss333

Copy link
Copy Markdown
Author

please review the updations as per the request..i have gone through the mentioned issues and possibly resolved it

@Jinsssss333 Jinsssss333 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

All reviewed and checked from my side

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

Labels

None yet

Projects

Status: Reviewed PRs that need fixes

Development

Successfully merging this pull request may close these issues.

docs: examples that references code should link to actual files in github

2 participants