docs: updated the "Read The Docs" documentation#4728
Merged
xrmx merged 10 commits intoopen-telemetry:mainfrom Aug 22, 2025
Merged
docs: updated the "Read The Docs" documentation#4728xrmx merged 10 commits intoopen-telemetry:mainfrom
xrmx merged 10 commits intoopen-telemetry:mainfrom
Conversation
…examples for consistency
Contributor
|
@jscancella Thanks for the PR but you need to sign the CLA in order to contribute to OpenTelemetry. |
Contributor
Author
|
ok, I just signed the agreement. Will it automatically pick that up or is there something else I need to do to kick it off again? |
Contributor
|
Please could you also add an entry to the Changelog for this update. |
Co-authored-by: Tammy Baylis <[email protected]>
Contributor
Author
Added an entry - but let me know if there is a different format or anything that needs to be changed |
xrmx
reviewed
Aug 21, 2025
Co-authored-by: Riccardo Magliocchetti <[email protected]>
tammy-baylis-swi
moved this from Reviewed PR that needs fixing
to Easy to review / merge / close
in Python PR digest
tammy-baylis-swi
approved these changes
Aug 21, 2025
Contributor
tammy-baylis-swi
left a comment
tammy-baylis-swi
left a comment
There was a problem hiding this comment.
Lgtm, thank you!
xrmx
reviewed
Aug 22, 2025
xrmx
approved these changes
Aug 22, 2025
github-project-automation
Bot
moved this from Easy to review / merge / close
to Done
in Python PR digest
JWinermaSplunk
pushed a commit
to JWinermaSplunk/opentelemetry-python
that referenced
this pull request
Feb 17, 2026
* docs: updated the ReadTheDocs documentation to all have links to the examples for consistency * Update docs/examples/metrics/prometheus-grafana/README.rst Co-authored-by: Tammy Baylis <[email protected]> * Added changelog entry as requested in PR feedback * fixed link to localhost to see the metrics * just use a plain http link * Update CHANGELOG.md Co-authored-by: Riccardo Magliocchetti <[email protected]> * fix tox reported issues * fix capitalization of Prometheus * Update CHANGELOG.md --------- Co-authored-by: Tammy Baylis <[email protected]> Co-authored-by: Riccardo Magliocchetti <[email protected]>
JWinermaSplunk
pushed a commit
to JWinermaSplunk/opentelemetry-python
that referenced
this pull request
Feb 17, 2026
* docs: updated the ReadTheDocs documentation to all have links to the examples for consistency * Update docs/examples/metrics/prometheus-grafana/README.rst Co-authored-by: Tammy Baylis <[email protected]> * Added changelog entry as requested in PR feedback * fixed link to localhost to see the metrics * just use a plain http link * Update CHANGELOG.md Co-authored-by: Riccardo Magliocchetti <[email protected]> * fix tox reported issues * fix capitalization of Prometheus * Update CHANGELOG.md --------- Co-authored-by: Tammy Baylis <[email protected]> Co-authored-by: Riccardo Magliocchetti <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
I noticed that several of the examples didn't link to their source code on github even though others did. To be consistent I added a link to the example in the README.rst files.
While working on this I also noticed that there was an example for prometheus but no entry in the Read The Docs generated, so I added one following the same style as the other pages.
Type of change
How Has This Been Tested?
generated documentation locally and inspected the html files. I checked all the links and make sure they were pointing to correct github example page.