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

Update all use of docs/shared in Grafana to use keyword arguments (#74167)

Browse Source 
* Update all use of docs/shared in Grafana to use keyword arguments

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add version inference to remaining Grafana docs/shared usage

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Jack Baldry
2023-08-31 11:00:04 +01:00
committed by GitHub
parent 164161b41a
commit 9ebcfeaf9e
33 changed files with 45 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/panels-visualizations/visualizations/bar-chart/index.md
+2 -2
View File
@@ -127,9 +127,9 @@ Transparency of the gradient is calculated based on the values on the y-axis. Op
Gradient color is generated based on the hue of the line color.
{{< docs/shared "visualizations/tooltip-mode.md" >}}
{{< docs/shared lookup="visualizations/tooltip-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
{{< docs/shared "visualizations/legend-mode.md" >}}
{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
### Legend calculations
docs/sources/panels-visualizations/visualizations/histogram/index.md
+2 -2
View File
@@ -71,9 +71,9 @@ Transparency of the gradient is calculated based on the values on the Y-axis. Th
Gradient color is generated based on the hue of the line color.
{{< docs/shared "visualizations/tooltip-mode.md" >}}
{{< docs/shared lookup="visualizations/tooltip-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
{{< docs/shared "visualizations/legend-mode.md" >}}
{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
### Legend calculations
docs/sources/panels-visualizations/visualizations/pie-chart/index.md
+2 -2
View File
@@ -77,9 +77,9 @@ The following example shows a pie chart with **Name** and **Percent** labels dis
![Pie chart labels](/static/img/docs/pie-chart-panel/pie-chart-labels-7-5.png)
{{< docs/shared "visualizations/tooltip-mode.md" >}}
{{< docs/shared lookup="visualizations/tooltip-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
{{< docs/shared "visualizations/legend-mode.md" >}}
{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
### Legend values
docs/sources/panels-visualizations/visualizations/state-timeline/index.md
+3 -3
View File
@@ -51,9 +51,9 @@ Controls line width of state regions.
Controls the opacity of state regions.
{{< docs/shared "visualizations/connect-null-values.md" >}}
{{< docs/shared lookup="visualizations/connect-null-values.md" source="grafana" version="<GRAFANA VERSION>" >}}
{{< docs/shared "visualizations/disconnect-values.md" >}}
{{< docs/shared lookup="visualizations/disconnect-values.md" source="grafana" version="<GRAFANA VERSION>" >}}
## Value mappings
@@ -71,4 +71,4 @@ The panel can be used with time series data as well. In this case, the threshold
When the legend option is enabled it can show either the value mappings or the threshold brackets. To show the value mappings in the legend, it's important that the `Color scheme` as referenced in [Color scheme]({{< relref "../../configure-standard-options/#color-scheme" >}}) is set to `Single color` or `Classic palette`. To see the threshold brackets in the legend set the `Color scheme` to `From thresholds`.
{{< docs/shared "visualizations/legend-mode.md" >}}
{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
docs/sources/panels-visualizations/visualizations/status-history/index.md
+1 -1
View File
@@ -64,4 +64,4 @@ use gradient color schemes to color values.
When the legend option is enabled it can show either the value mappings or the threshold brackets. To show the value mappings in the legend, it's important that the `Color scheme` as referenced in [Color scheme]({{< relref "../../configure-standard-options/#color-scheme" >}}) is set to `Single color` or `Classic palette`. To see the threshold brackets in the legend set the `Color scheme` to `From thresholds`.
{{< docs/shared "visualizations/legend-mode.md" >}}
{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
docs/sources/panels-visualizations/visualizations/time-series/index.md
+4 -4
View File
@@ -47,13 +47,13 @@ You can migrate from the old Graph visualization to the new Time series visualiz
Tooltip options control the information overlay that appears when you hover over data points in the graph.
{{< docs/shared "visualizations/tooltip-mode.md" >}}
{{< docs/shared lookup="visualizations/tooltip-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
## Legend options
Legend options control the series names and statistics that appear under or to the right of the graph.
{{< docs/shared "visualizations/legend-mode.md" >}}
{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="<GRAFANA VERSION>" >}}
## Graph styles
@@ -136,9 +136,9 @@ Set the style of the line. To change the color, use the standard [color scheme](
![Line styles examples](/static/img/docs/time-series-panel/line-styles-examples-v9.png)
{{< docs/shared "visualizations/connect-null-values.md" >}}
{{< docs/shared lookup="visualizations/connect-null-values.md" source="grafana" version="<GRAFANA VERSION>" >}}
{{< docs/shared "visualizations/disconnect-values.md" >}}
{{< docs/shared lookup="visualizations/disconnect-values.md" source="grafana" version="<GRAFANA VERSION>" >}}
### Stack series