[DOC] Create a suite of pages for Explore Traces #235
Conversation
| @@ -0,0 +1,175 @@ | |||
| --- | |||
There was a problem hiding this comment.
NOT WRITTEN. Skip this page.
|
The drone build failing at spell check is a known issue and being worked on. It's not related to the vale and linter checks for docs. |
docs/sources/access/index.md
Outdated
| - Tempo 2.6 or newer | ||
| - A configured [Tempo data source](https://grafana.com/docs/grafana/latest/datasources/tempo/configure-tempo-data-source/) receiving tracing data | ||
|
|
||
| Once installed, you can access Explore Traces: |
There was a problem hiding this comment.
| Once installed, you can access Explore Traces: | |
| Once installed, to access Explore Traces: |
There was a problem hiding this comment.
Sorry, I'm a bit lost. Should the "once installed" section be after all the config steps? Are these the config steps:
- Before you begin - Grafana instance, Tempo 2.6+, Tempo DS
- Install plugin either with CLI or in Grafana GUI
Also have questions about why I would install in Docker container? Maybe separate out:
- To install in instance, do these things.
- To install in Docker container (instead of instance?), (instructions)
There was a problem hiding this comment.
This is one of those sections that gets a little confusing because you can install or run Grafana in multiple ways -- including using it in a Docker container. The Docker container is actually how I used the plugin.
There was a problem hiding this comment.
I thought about putting the "to access" section after the installation part. Sounds like I should
There was a problem hiding this comment.
I've moved the Access steps to the bottom and have reworked the other sections to be set up instead of access. I think that makes it clearer. thank you for the suggestions!
|
|
||
| You can refine any selected views by selecting a Profile type, Label, or Flame graph from one of the charts. | ||
| Click and drag on an area of interest to see more detail. | ||
|
|
There was a problem hiding this comment.
Hopefully, there's images that refine the difference between choosing and selecting a view. This seems muddy to me, but I'm not familiar with this at all, lol.
There was a problem hiding this comment.
Don't worry abourt this page. The Views page isn't updated for traces since it is absed on profiles.
docs/sources/access/index.md
Outdated
|
|
||
| To use Explore Traces with Grafana Cloud, you need: | ||
|
|
||
| - A Grafana Cloud account |
There was a problem hiding this comment.
In the preceding section, you punctuated your lists, but here (and below) you didn't. I don't think it matters either way, but we should probably be consistent throughout.
There was a problem hiding this comment.
This made me go and look at the Google Developer Style guide for bulleted lists, https://developers.google.com/style/lists
Let me check on this.
There was a problem hiding this comment.
Okay, Google Style Guide says - if the item doesn't include a verb, don't add end punctuation. So, in the case of the requirements section, these bullets should not have end punctuation. In the cast of the first section, where there are complete sentences with a run-in heading, there should be end punctuation.
There was a problem hiding this comment.
Thanks for looking into this!
|
|
||
| 1. In Grafana, go to **Administration** > **Plugins and data** > **Plugins**. | ||
| 2. Search for "Explore Traces". | ||
| 3. Select Explore Traces. |
There was a problem hiding this comment.
Is this a UI element or an item on a list? Do we need bold?
There was a problem hiding this comment.
It's a plugin name, so neither a UI element nor an item on a list. It comes up as a tile on the plugin list.
Co-authored-by: Taylor C <[email protected]> Co-authored-by: Heitor Tashiro Sergent <[email protected]>
Create a suite of pages from the one long doc page. The screenshot will be replaced with a video when it's available. The video will be a smaller size.
Note that there are two pages that are commented out and need to be written: choose a view and Determine use case.
Fixes #234