Skip to content

docs: link example source files from READMEs - #5515

Open
slegarraga wants to merge 1 commit into
open-telemetry:mainfrom
slegarraga:docs/example-source-links
Open

docs: link example source files from READMEs#5515
slegarraga wants to merge 1 commit into
open-telemetry:mainfrom
slegarraga:docs/example-source-links

Conversation

@slegarraga

Copy link
Copy Markdown

Summary

Adds :scm_web: source links to example READMEs that referenced code without linking it, and converts the remaining raw GitHub tree URL to the same role.

Changes

  • Links each listed example file in docs/examples/metrics/views/README.rst.
  • Adds source links to the sqlcommenter, auto-instrumentation, Flask gunicorn, and Flask uWSGI READMEs.
  • Adds source links to the error handler subexample READMEs.
  • Replaces the raw GitHub URL in sqlcommenter with :scm_web: for consistency with the rest of the tree.

Verification

  • Every README.rst under docs/examples now includes :scm_web:.
  • No remaining raw github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples links.

Closes #5427

@slegarraga
slegarraga requested a review from a team as a code owner August 6, 2026 18:42
@linux-foundation-easycla

linux-foundation-easycla Bot commented Aug 6, 2026

Copy link
Copy Markdown

CLA Not Signed

@opentelemetry-pr-dashboard

Copy link
Copy Markdown

Pull request dashboard status

Waiting on the author · refreshed 2026-08-14 16:59 UTC

Investigate required status check failures.

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.
  • Should this be with reviewers? Comment /dashboard route:reviewers to route it to them.
  • Anything wrong — including the routing? Report it with what you expected; it helps us improve the dashboard.

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.

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

1 participant