Fix all the old usage of admonition syntax (#107098)
This commit is contained in:
Jack Baldry
@@ -201,9 +201,9 @@ Variables in data links and actions let you send people to a detailed dashboard
|
||||
|
||||
To see a list of available variables, enter `$` in the data link or action **URL** field.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
These variables changed in 6.4 so if you have an older version of Grafana, then use the version picker to select docs for an older version of Grafana.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
Azure Monitor, [CloudWatch](ref:cloudwatch), and [Google Cloud Monitoring](ref:google-cloud-monitoring) have pre-configured data links called _deep links_.
|
||||
|
||||
|
||||
@@ -97,9 +97,9 @@ Legends are supported for the following visualizations:
|
||||
|
||||
You can find the following options under the **Legend** section in the panel edit pane.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Not all of the options listed apply to all visualizations with legends.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
### Visibility
|
||||
|
||||
@@ -175,6 +175,6 @@ When you format a legend as a table and add values to it, you can sort series in
|
||||
|
||||
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
This feature is only supported for the following visualizations: bar chart, histogram, time series.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
@@ -152,9 +152,9 @@ This section explains all available standard options.
|
||||
|
||||
To set these options, expand the **Standard options** section in the panel editor pane. Most field options won't affect the visualization until you click outside of the field option box you're editing or press Enter.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Not all of the options listed apply to all visualizations with standard options.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
### Unit
|
||||
|
||||
|
||||
@@ -106,9 +106,9 @@ Some visualizations, for example [candlestick](ref:candlestick) and [flame graph
|
||||
|
||||
You can find the following options under the **Tooltip** section in the panel edit pane.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Not all of the options listed apply to all visualizations with tooltips.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
### Tooltip mode
|
||||
|
||||
|
||||
@@ -117,9 +117,9 @@ To get started adding panels, ensure that you have configured a data source:
|
||||
- For details about using data sources, refer to [Data sources](ref:data-sources).
|
||||
- For more information about managing data sources as an administrator, refer to [Data source management](ref:data-source-management).
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
[Data source management](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/administration/data-source-management/) is only available in [Grafana Enterprise](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/introduction/grafana-enterprise/) and [Grafana Cloud](https://grafana.com/docs/grafana-cloud/).
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
## Panel feature overview
|
||||
|
||||
|
||||
@@ -189,9 +189,9 @@ Panel data source query options include:
|
||||
If a data point is saved every 15 seconds, you don't benefit from having an interval lower than that.
|
||||
You can also set this to a higher minimum than the scrape interval to retrieve queries that are more coarse-grained and well-functioning.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
The **Min interval** corresponds to the min step in Prometheus. Changing the Prometheus interval can change the start and end of the query range because Prometheus aligns the range to the interval. Refer to [Min step](https://grafana.com/docs/grafana/latest/datasources/prometheus/query-editor/#min-step) for more details.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
- **Interval:** Sets a time span that you can use when aggregating or grouping data points by time.
|
||||
|
||||
|
||||
@@ -48,15 +48,15 @@ Server-side expressions allow you to manipulate data returned from queries with
|
||||
|
||||
Expressions are most commonly used for [Grafana Alerting](ref:grafana-alerting). The processing is done server-side, so expressions can operate without a browser session. However, expressions can also be used with backend data sources and visualization.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Expressions do not work with legacy dashboard alerts.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
Expressions are meant to augment data sources by enabling queries from different data sources to be combined or by providing operations unavailable in a data source.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
When possible, you should do data processing inside the data source. Copying data from storage to the Grafana server for processing is inefficient, so expressions are targeted at lightweight data processing.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
Expressions work with data source queries that return time series or number data. They also operate on [multiple-dimensional data](ref:multiple-dimensional-data). For example, a query that returns multiple series, where each series is identified by labels or tags.
|
||||
|
||||
@@ -142,9 +142,9 @@ abs returns the absolute value of its argument which can be a number or a series
|
||||
|
||||
is_inf takes a number or a series and returns `1` for `Inf` values (negative or positive) and `0` for other values. For example `is_inf($A)`.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
If you need to specifically check for negative infinity for example, you can do a comparison like `$A == infn()`.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
###### is_nan
|
||||
|
||||
|
||||
@@ -157,7 +157,7 @@ Grafana offers a variety of visualizations to support different use cases. This
|
||||
|
||||
{{< youtube id="JwF6FgeotaU" >}}
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
If you are unsure which visualization to pick, Grafana can provide visualization suggestions based on the panel query. When you select a visualization, Grafana will show a preview with that visualization applied.
|
||||
{{< /admonition >}}
|
||||
|
||||
|
||||
@@ -116,9 +116,9 @@ The candlestick visualization attempts to map fields from your data to the appro
|
||||
- **Close** - Final (end) value of the given period.
|
||||
- **Volume** - Sample count in the given period (for example, number of trades).
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
The candlestick visualization legend doesn't display these values.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
If your data can't be mapped to these dimensions for some reason (for example, because the column names aren't the same), you can map them manually using the **Open**, **High**, **Low**, and **Close** fields under the **Candlestick** options in the panel editor:
|
||||
|
||||
|
||||
@@ -63,9 +63,9 @@ Elements are the basic building blocks of a canvas and they help you visualize d
|
||||
|
||||
Add elements in the [Layer](#layer-options) section of canvas options.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Element snapping and alignment only works when the canvas is not zoomed in.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
### Element types
|
||||
|
||||
@@ -136,9 +136,9 @@ The server element lets you easily represent a single server, a stack of servers
|
||||
|
||||
The button element lets you add a basic button to the canvas. Button elements support triggering basic, unauthenticated API calls. [API settings](#button-api-options) are found in the button element editor. You can also pass template variables in the API editor.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
A button click will only trigger an API call when [inline editing](#inline-editing) is disabled.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
{{< video-embed src="/media/docs/grafana/2023-20-10-Canvas-Button-Element-Enablement-Video.mp4" max-width="650px" alt="Canvas button element demo" >}}
|
||||
|
||||
@@ -271,9 +271,9 @@ Use the following pointer and keyboard strokes:
|
||||
|
||||
You can enable infinite panning in a canvas when pan and zoom is enabled. This allows you to pan and zoom the canvas and uncover larger designs.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Infinite panning is an experimental feature that may not work as expected in all scenarios. For example, elements that are not top-left constrained may experience unexpected movement when panning.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
### Layer options
|
||||
|
||||
|
||||
@@ -221,9 +221,9 @@ There are seven map layer types to choose from in a geomap.
|
||||
- [ArcGIS MapServer](#arcgis-mapserver-layer) adds a layer from an ESRI ArcGIS MapServer.
|
||||
- [XYZ Tile layer](#xyz-tile-layer) adds a map from a generic tile layer.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Beta is equivalent to the [public preview](/docs/release-life-cycle/) release stage.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
There are also two experimental (or alpha) layer types.
|
||||
|
||||
@@ -358,9 +358,9 @@ The Night / Day layer displays night and day regions based on the current time r
|
||||
|
||||
#### Route layer (Beta)
|
||||
|
||||
{{% admonition type="caution" %}}
|
||||
{{< admonition type="caution" >}}
|
||||
The Route layer is currently in [public preview](/docs/release-life-cycle/). Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
The Route layer renders data points as a route.
|
||||
|
||||
@@ -387,9 +387,9 @@ The layer can also render a route with arrows.
|
||||
|
||||
#### Photos layer (Beta)
|
||||
|
||||
{{% admonition type="caution" %}}
|
||||
{{< admonition type="caution" >}}
|
||||
The Photos layer is currently in [public preview](/docs/release-life-cycle/). Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
The Photos layer renders a photo at each data point.
|
||||
|
||||
@@ -414,9 +414,9 @@ The Photos layer renders a photo at each data point.
|
||||
|
||||
#### Network layer (Beta)
|
||||
|
||||
{{% admonition type="caution" %}}
|
||||
{{< admonition type="caution" >}}
|
||||
The Network layer is currently in [public preview](/docs/release-life-cycle/). Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
The Network layer renders a network graph. This layer supports the same [data format supported by the node graph visualization](ref:data-format) with the addition of [geospatial data](#location-mode) included in the nodes data. The geospatial data is used to locate and render the nodes on the map.
|
||||
|
||||
|
||||
@@ -24,9 +24,9 @@ The news visualization displays an RSS feed. By default, it displays articles fr
|
||||
|
||||
{{< figure src="/static/img/docs/news/news-visualization.png" max-width="1025px" alt="A news visualization showing the latest Grafana news feed" >}}
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
In version 8.5, we discontinued the "Use Proxy" option for Grafana news visualizations. As a result, RSS feeds that are not configured for request by Grafana's frontend (with the appropriate [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)) may not load.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
You can use the news visualization to provide regular news and updates to your users.
|
||||
|
||||
|
||||
@@ -92,9 +92,9 @@ Both nodes and edges can have associated metadata or statistics. The data source
|
||||
|
||||
#### Nodes
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Node graphs can show only 1,500 nodes. If this limit is crossed a warning will be visible in upper right corner, and some nodes will be hidden. You can expand hidden parts of the graph by clicking on the "Hidden nodes" markers in the graph.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
Usually, nodes show two statistical values inside the node and two identifiers just below the node, usually name and type. Nodes can also show another set of values as a color circle around the node, with sections of different color represents different values that should add up to 1.
|
||||
|
||||
|
||||
@@ -36,9 +36,9 @@ For example, if you're monitoring the health status of different services, you c
|
||||
|
||||
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-status-history-v11.6.png" max-width="800px" alt="A status history panel showing the health status of different sensors" >}}
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
A status history is similar to a [state timeline](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/panels-visualizations/visualizations/state-timeline/), but has different [configuration options](#status-history-options). Unlike state timelines, status histories don't merge consecutive values.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
Use a status history when you need to:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user