docs: updated the "Read The Docs" documentation #4728
+75
−4
Conversation
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
…examples for consistency
|
@jscancella Thanks for the PR but you need to sign the CLA in order to contribute to OpenTelemetry. |
|
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? |
| Prometheus Instrumentation | ||
| ========================== | ||
|
|
||
| This shows how to use ``opentelemetry-exporter-prometheus`` to automatically generate prometheus metrics. |
There was a problem hiding this comment.
Thanks for this PR! Nit: I think "Prometheus" should be capitalized
Suggested change
| This shows how to use ``opentelemetry-exporter-prometheus`` to automatically generate prometheus metrics. | |
| This shows how to use ``opentelemetry-exporter-prometheus`` to automatically generate Prometheus metrics. |
|
Please could you also add an entry to the Changelog for this update. |
Co-authored-by: Tammy Baylis <96076570+tammy-baylis-swi@users.noreply.github.com>
| $ python ./prometheus-monitor.py | ||
| $ Server is running at http://localhost:8000 | ||
| Now you can visit `localhost:8000/metrics <http://localhost:8000/metrics>` to see Prometheus metrics. |
There was a problem hiding this comment.
The docs ci/cd doesn't like this format. Maybe plain http://localhost:8000/metrics or `http://localhost:8000/metrics` instead?
Added an entry - but let me know if there is a different format or anything that needs to be changed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.