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

@slegarraga
slegarraga force-pushed the docs/example-source-links branch from 230f6cd to c16faf7 Compare August 8, 2026 20:50
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