Revert "[v9.4.x] [feat] docs; update admonition syntax" (#68982)

Revert "[v9.4.x] [feat] docs; update admonition syntax (#68855)" This reverts commit 048de5d09a.
2023-05-24 14:53:21 +01:00
parent 136cb16a52
commit 7daa240753
144 changed files with 1241 additions and 3890 deletions
@@ -14,9 +14,7 @@ weight: 75

 Grafana offers a variety of visualizations to support different use cases. This section of the documentation highlights the built-in panels, their options and typical usage.

-{{% 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 %}}
+> **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.

 - Graphs & charts
  - [Time series]({{< relref "time-series/" >}}) is the default and main Graph visualization.
@@ -39,9 +39,7 @@ Use the time range option to specify whether the list should be limited to the c

 Use the tags option to filter the annotations by tags. You can add multiple tags in order to refine the list.

-{{% admonition type="note" %}}
-Optionally, leave the tag list empty and filter on the fly by selecting tags that are listed as part of the results on the panel itself.
-{{% /admonition %}}
+> **Note:** Optionally, leave the tag list empty and filter on the fly by selecting tags that are listed as part of the results on the panel itself.

 ### Limit

@@ -48,9 +48,7 @@ The **Up color** and **Down color** options select which colors are used when th

 The candlestick panel will attempt to map fields to the appropriate dimension. The **Open**, **High**, **Low**, and **Close** options allow you to map your data to these dimensions if the panel is unable to do so.

-{{% admonition type="note" %}}
-These values are hidden from the legend.
-{{% /admonition %}}
+> **Note**: These values are hidden from the legend.

 - **Open** corresponds to the starting value of the given period.
 - **High** corresponds to the highest value of the given period.
@@ -88,9 +88,7 @@ There are also five alpha layer types.
 - **Route (alpha)** render data points as a route.
 - [Photos layer (Alpha)]({{< relref "#photos-layer-alpha" >}}) renders a photo at each data point.

-{{% admonition type="note" %}}
-[Basemap layer types]({{< relref "#types-1" >}}) can also be added as layers. You can specify an opacity.
-{{% /admonition %}}
+> **Note:** [Basemap layer types]({{< relref "#types-1" >}}) can also be added as layers. You can specify an opacity.

 ### Layer Controls

@@ -412,9 +410,7 @@ Displays scale information in the bottom left corner.

 {{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-scale-9-1-0.png" max-width="1200px" caption="Geomap panel scale" >}}

-{{% admonition type="note" %}}
-Currently only displays units in [m]/[km].
-{{% /admonition %}}
+> **Note:** Currently only displays units in [m]/[km].

 ### Show measure tools

@@ -426,9 +422,7 @@ Displays measure tools in the upper right corner. Measurements appear only when
 - **Continue clicking** to continue measurement
 - **Double-click** to end measurement

-{{% admonition type="note" %}}
-<br /- When you change measurement type or units, the previous measurement is removed from the map. <br /- If the control is closed and then re-opened, the most recent measurement is displayed. <br /- A measurement can be modified by clicking and dragging on it.
-{{% /admonition %}}
+> **Note:** <br /> - When you change measurement type or units, the previous measurement is removed from the map. <br /> - If the control is closed and then re-opened, the most recent measurement is displayed. <br /> - A measurement can be modified by clicking and dragging on it.

 #### Length

@@ -32,9 +32,7 @@ Both nodes and edges can have associated metadata or statistics. The data source

 ### Nodes

-{{% admonition type="note" %}}
-Node graph 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 %}}
+> **Note:** Node graph 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.

 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.

@@ -20,9 +20,7 @@ The Stat panel visualization shows a one large stat value with an optional graph

 {{< figure src="/static/img/docs/v66/stat_panel_dark3.png" max-width="1025px" caption="Stat panel" >}}

-{{% admonition type="note" %}}
-This panel replaces the Singlestat panel, which was deprecated in Grafana 7.0 and removed in Grafana 8.0.
-{{% /admonition %}}
+> **Note:** This panel replaces the Singlestat panel, which was deprecated in Grafana 7.0 and removed in Grafana 8.0.

 By default, the Stat panel displays one of the following:

@@ -33,15 +33,13 @@ Annotations are not currently supported in the new table panel. This might be ad

 ## Sort column

-Click a column title to change the sort order from default to descending to ascending. Each time you click, the sort order changes to the next option in the cycle. You can sort multiple columns by holding the `shift` key and clicking the column name.
+Click a column title to change the sort order from default to descending to ascending. Each time you click, the sort order changes to the next option in the cycle. You can only sort by one column at a time.

 ![Sort descending](/static/img/docs/tables/sort-descending.png 'Sort descending')

 ## Table options

-{{% admonition type="note" %}}
-If you are using a table visualization created before Grafana 7.0, then you need to migrate to the new table version in order to see these options. To migrate, on the Panel tab, click **Table** visualization. Grafana updates the table version and you can then access all table options.
-{{% /admonition %}}
+> **Note:** If you are using a table visualization created before Grafana 7.0, then you need to migrate to the new table version in order to see these options. To migrate, on the Panel tab, click **Table** visualization. Grafana updates the table version and you can then access all table options.

 ### Show header

@@ -74,9 +72,7 @@ Choose how Grafana should align cell contents:

 By default, Grafana automatically chooses display settings. You can override the settings by choosing one of the following options to set the default for all fields. Additional configuration is available for some cell types.

-{{% admonition type="note" %}}
-If you set these in the Field tab, then the type will apply to all fields, including the time field. Many options will work best if you set them in the Override tab so that they can be restricted to one or more fields.
-{{% /admonition %}}
+> **Note:** If you set these in the Field tab, then the type will apply to all fields, including the time field. Many options will work best if you set them in the Override tab so that they can be restricted to one or more fields.

 ### Color text

@@ -112,22 +108,6 @@ The gauge is split up in small cells that are lit or unlit.

 {{< figure src="/static/img/docs/tables/lcd-gauge.png" max-width="500px" caption="LCD gauge" class="docs-image--no-shadow" >}}

-#### Label Options
-
-Additionally, labels displayed alongside of the gauges can be set to be colored by value, match the theme text color, or be hidden.
-
-**Value Color**
-
-{{< figure src="/static/img/docs/tables/value-color-mode.png" max-width="500px" caption="Color Label by Value" class="docs-image--no-shadow" >}}
-
-**Text Color**
-
-{{< figure src="/static/img/docs/tables/text-color-mode.png" max-width="500px" caption="Color Label by theme color" class="docs-image--no-shadow" >}}
-
-**Hidden**
-
-{{< figure src="/static/img/docs/tables/hidden-mode.png" max-width="500px" caption="Hide Label" class="docs-image--no-shadow" >}}
-
 ### JSON view

 Shows value formatted as code. If a value is an object the JSON view allowing browsing the JSON object will appear on hover.
@@ -142,23 +122,11 @@ If you have a field value that is an image URL or a base64 encoded image you can

 {{< figure src="/static/img/docs/v73/table_hover.gif" max-width="900px" caption="Table hover" >}}

-### Sparkline
-
-{{% admonition type="note" %}}
-This cell type is available in Grafana 9.5+ as an opt-in beta feature. Modify Grafana [configuration file]({{< relref "../../../setup-grafana/configure-grafana/#configuration-file-location" >}}) to enable the `timeSeriesTable` [feature toggle]({{< relref "../../../setup-grafana/configure-grafana/#feature_toggles" >}}) to use it.
-{{% /admonition %}}
-
-Shows value rendered as a sparkline. Requires [time series to table]({{< relref "../../query-transform-data/transform-data/#time-series-to-table-transform" >}}) data transform.
-
-{{< figure src="/static/img/docs/tables/sparkline.png" max-width="500px" caption="Sparkline" class="docs-image--no-shadow" >}}
-
 ## Cell value inspect

 Enables value inspection from table cell. The raw value is presented in a modal window.

-{{% admonition type="note" %}}
-Cell value inspection is only available when cell display mode is set to Auto, Color text, Color background or JSON View.
-{{% /admonition %}}
+> **Note:** Cell value inspection is only available when cell display mode is set to Auto, Color text, Color background or JSON View.

 ## Column filter

@@ -34,9 +34,7 @@ weight: 90

 The time series visualization type is the default and primary way to visualize time series data as a graph. It can render series as lines, points, or bars. It is versatile enough to display almost any time-series data. [This public demo dashboard](https://play.grafana.org/d/000000016/1-time-series-graphs?orgId=1) contains many different examples of how it can be configured and styled.

-{{% admonition type="note" %}}
-You can migrate from the old Graph visualization to the new Time series visualization. To migrate, open the panel and click the **Migrate** button in the side pane.
-{{% /admonition %}}
+> **Note:** You can migrate from the old Graph visualization to the new Time series visualization. To migrate, open the panel and click the **Migrate** button in the side pane.

 ## Tooltip options

@@ -224,9 +222,7 @@ Use this option to transform the series values without affecting the values show
 - **Negative Y transform:** Flip the results to negative values on the Y axis.
 - **Constant:** Show the first value as a constant line.

-{{% admonition type="note" %}}
-The transform option is only available as an override.
-{{% /admonition %}}
+> **Note:** The transform option is only available as an override.

 ## Color options

@@ -13,9 +13,7 @@ weight: 850

 # Traces panel

-{{% admonition type="note" %}}
-This panel is currently in beta. Expect changes in future releases.
-{{% /admonition %}}
+> **Note:** This panel is currently in beta. Expect changes in future releases.

 _Traces_ are a visualization that enables you to track and log a request as it traverses the services in your infrastructure.