Skip to content

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

Description

@xrmx

The rendered docs/examples on read the docs references examples we have in github but some pages do not properly link them and so it's hard for an end user to find the code. For example
https://opentelemetry-python.readthedocs.io/en/stable/examples/metrics/views/README.html lists a bunch of python files but these are not linked to github.

An example with a proper link is https://opentelemetry-python.readthedocs.io/en/stable/examples/django/README.html that is docs/examples/django/README.rst.

So we should review all the content of docs/examples and add proper :scm_web: links.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions