Skip to content

docs: add :scm_web: links to example README files referencing source code#5433

Open
harshitnagar22 wants to merge 2 commits into
open-telemetry:mainfrom
harshitnagar22:main
Open

docs: add :scm_web: links to example README files referencing source code#5433
harshitnagar22 wants to merge 2 commits into
open-telemetry:mainfrom
harshitnagar22:main

Conversation

@harshitnagar22

Copy link
Copy Markdown

What

Added :scm_web: links to 6 README.rst files under docs/examples/ so the rendered docs link back to the actual source files on GitHub.

Why

Fixes #5427 — some example README pages on Read the Docs list Python files but don't link them, making it hard for users to find the actual source code.

Changes

File Change
docs/examples/auto-instrumentation/README.rst Added :scm_web: link
docs/examples/error_handler/error_handler_0/README.rst Added :scm_web: link
docs/examples/error_handler/error_handler_1/README.rst Added :scm_web: link
docs/examples/fork-process-model/flask-gunicorn/README.rst Added :scm_web: link
docs/examples/fork-process-model/flask-uwsgi/README.rst Added :scm_web: link
docs/examples/sqlcommenter/README.rst Replaced hardcoded GitHub URL with :scm_web:

Follows the same pattern used in docs/examples/django/README.rst.

@harshitnagar22
harshitnagar22 requested a review from a team as a code owner July 18, 2026 07:58
@linux-foundation-easycla

linux-foundation-easycla Bot commented Jul 18, 2026

Copy link
Copy Markdown

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

@AJ-ing

AJ-ing commented Jul 25, 2026

Copy link
Copy Markdown

Thanks for tackling #5427!

I audited docs/examples on current main: the only READMEs still missing :scm_web: are exactly the six files in this PR (auto-instrumentation, sqlcommenter, error_handler_{0,1}, flask-gunicorn, flask-uwsgi). The parent examples already link correctly.

One nit for consistency with docs/examples/django/README.rst / metrics/views/README.rst: prefer :scm_web: links over raw GitHub URLs where possible (sqlcommenter currently uses a raw link on main).

I'll stay out of the way so maintainers can pick one complete PR among #5428 / #5429 / #5433.

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

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

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

2 participants