public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[v10.0.x] [feat] docs; update admonition syntax (#68857)

Browse Source 
[feat] docs; update admonition syntax (#68842)

* [feat] docs; update admonition syntax

- Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
- Prepares docs for better, uniform admonition style.

* Remove false positives and irregularities

* false positive removal

* Update docs/sources/datasources/mysql/_index.md

* Update docs/sources/developers/angular_deprecation/angular-plugins.md

* fix link errors

* Prettify some nested blockquotes

* remoe unnecessary admonition

(cherry picked from commit 1c4bb9ca00)

Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
This commit is contained in:
Grot (@grafanabot)
2023-05-23 07:47:49 -05:00
committed by GitHub
co-authored by Matt Dodson
parent defce65315
commit 1e8c28eff4
144 changed files with 1840 additions and 405 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/explore/_index.md
+3 -1
View File
@@ -67,7 +67,9 @@ To close the newly created query, click on the Close Split button.
## Share shortened link
> **Note:** Available in Grafana 7.3 and later versions.
{{% admonition type="note" %}}
Available in Grafana 7.3 and later versions.
{{% /admonition %}}
The Share shortened link capability allows you to create smaller and simpler URLs of the format /goto/:uid instead of using longer URLs with query parameters. To create a shortened link to the executed query, click the **Share** option in the Explore toolbar. A shortened link that is never used will automatically get deleted after seven (7) days.
docs/sources/explore/query-management.md
+3 -1
View File
@@ -19,7 +19,9 @@ This functionality is similar to the panel inspector tasks [Inspect query perfor
Query history is a list of queries that you used in Explore. The history is stored in the Grafana database and it is not shared with other users. The retention period for queries in history is two weeks. Queries older than two weeks are automatically deleted. To open and interact with your history, click the **Query history** button in Explore.
> **Note**: Starred queries are not subject to the two weeks retention period and they are not deleted.
{{% admonition type="note" %}}
Starred queries are not subject to the two weeks retention period and they are not deleted.
{{% /admonition %}}
### View query history
docs/sources/explore/trace-integration.md
+10 -4
View File
@@ -42,8 +42,10 @@ Shows condensed view or the trace timeline. Drag your mouse over the minimap to
### Span Filters
> **Note:** This feature is behind the `newTraceViewHeader` [feature toggle]({{< relref "../../setup-grafana/configure-grafana#feature_toggles" >}}).
> If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature.
{{% admonition type="note" %}}
This feature is behind the `newTraceViewHeader` [feature toggle]({{< relref "../../setup-grafana/configure-grafana#feature_toggles" >}}).
If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature.
{{% /admonition %}}
![Screenshot of span filtering](/media/docs/tempo/screenshot-grafana-tempo-span-filters.png)
@@ -81,7 +83,9 @@ Clicking anywhere on the span row shows span details.
### Trace to logs
> **Note:** Available in Grafana 7.4 and later versions.
{{% admonition type="note" %}}
Available in Grafana 7.4 and later versions.
{{% /admonition %}}
You can navigate from a span in a trace view directly to logs relevant for that span. This feature is available for Tempo, Jaeger, and Zipkin data sources. Refer to their [relevant documentation](/docs/grafana/latest/datasources/tempo/#trace-to-logs) for configuration instructions.
@@ -91,7 +95,9 @@ Click the document icon to open a split view in Explore with the configured data
### Trace to metrics
> **Note:** This feature is currently in beta & behind the `traceToMetrics` feature toggle.
{{% admonition type="note" %}}
This feature is currently in beta & behind the `traceToMetrics` feature toggle.
{{% /admonition %}}
You can navigate from a span in a trace view directly to metrics relevant for that span. This feature is available for Tempo, Jaeger, and Zipkin data sources. Refer to their [relevant documentation](/docs/grafana/latest/datasources/tempo/#trace-to-metrics) for configuration instructions.