Grafana cloud docs for tempo and loki #1788
Conversation
|
@arikalon1 adding you as reviewer instead of me, as you saw this issue with a user and helped them |
WalkthroughThe documentation for obtaining Grafana Loki and Tempo datasource UIDs was reorganized to use tabbed interfaces, separating instructions for "Self Hosted" and "Grafana Cloud" environments. Graphical instructions with images were added for Grafana Cloud users, while existing command-line instructions were retained under the "Self Hosted" tabs. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
User->>Documentation: Open Loki/Tempo UID instructions
alt Self Hosted
Documentation->>User: Show CLI/API steps under "Self Hosted" tab
else Grafana Cloud
Documentation->>User: Show graphical steps with images under "Grafana Cloud" tab
end
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/configuration/holmesgpt/toolsets/grafanaloki.rst (2)
50-84: Consistent tab-label naming for better UXIn this file the tab is titled “Self Hosted”, whereas in the Tempo doc the equivalent tab is “Self Hosted Tempo”. Pick one convention (e.g. “Self Hosted Loki” or simply “Self Hosted”) and use it across all toolsets so readers instantly understand they are parallel instructions.
87-99: Add alt-text to the screenshotsBoth image directives lack an explicit “:alt:” attribute. Supplying alt text improves accessibility and also provides context when images fail to load.
- .. image:: /images/grafana-loki-holmes-uid1.png + .. image:: /images/grafana-loki-holmes-uid1.png + :alt: Selecting a Loki datasource in Grafana CloudRepeat for the second image.
docs/configuration/holmesgpt/toolsets/grafanatempo.rst (2)
41-42: Align tab-label naming with Loki docHere the tab is called “Self Hosted Tempo”. The Loki doc uses “Self Hosted”. Standardise the wording across both docs for clarity and to avoid confusing readers switching between them.
75-77: Add alt-text to Tempo screenshotsWhile fixing the directive spacing, take the opportunity to provide “:alt:” text for accessibility.
- .. image:: /images/grafana-tempo-holmes-uid1.png + .. image:: /images/grafana-tempo-holmes-uid1.png + :alt: Selecting a Tempo datasource in Grafana CloudAlso applies to: 81-83
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
docs/images/grafana-loki-holmes-uid1.pngis excluded by!**/*.pngdocs/images/grafana-loki-holmes-uid2.pngis excluded by!**/*.pngdocs/images/grafana-tempo-holmes-uid1.pngis excluded by!**/*.pngdocs/images/grafana-tempo-holmes-uid2.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/configuration/holmesgpt/toolsets/grafanaloki.rst(1 hunks)docs/configuration/holmesgpt/toolsets/grafanatempo.rst(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: run_tests
- GitHub Check: run_tests
- GitHub Check: Deploy docs
| .. image :: /images/grafana-tempo-holmes-uid1.png | ||
| :width: 600 | ||
| :align: center |
There was a problem hiding this comment.
RST build will fail—extra space before “::” in image directives
The directives read .. image ::, but ReStructuredText requires .. image:: (no space). Sphinx will treat these as unknown directives and throw an error.
- .. image :: /images/grafana-tempo-holmes-uid1.png
+ .. image:: /images/grafana-tempo-holmes-uid1.pngApply the same fix to the second image block.
Also applies to: 81-83
🤖 Prompt for AI Agents
In docs/configuration/holmesgpt/toolsets/grafanatempo.rst around lines 75 to 77
and also lines 81 to 83, the image directives incorrectly have a space before
the double colon (`.. image ::`). Remove the extra space so the directives read
`.. image::` with no space before the colons to comply with ReStructuredText
syntax and prevent build errors.
This part related to labels is not updated
When I run something like the following to get the labels. I get a full HTML page instead. Not sure what parts are important and how to find labels etc either.