Skip to content

Commit 5f066d9

Browse files
committed
docs: add a page dedicated to examples in the Foundation SDK docs
1 parent ecbfa72 commit 5f066d9

File tree

5 files changed

+160
-0
lines changed

5 files changed

+160
-0
lines changed

package_templates/go/docs/Examples.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
weight: 10
3+
---
4+
# Examples
5+
6+
A collection of sample Grafana dashboards written in Go is available in the [grafana/grafana-foundation-sdk](https://github.com/grafana/grafana-foundation-sdk/) repository.
7+
8+
Each example showcases different aspects of building dashboards as code:
9+
10+
* [`custom-panel`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/go/custom-panel): definition and usage of a _custom_ Panel type
11+
* [`custom-query`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/go/custom-query): definition and usage of a _custom_ Query type
12+
* [`grafana-agent-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/go/grafana-agent-overview):
13+
* reproduction of the "Grafana Agent Overview" dashboard from
14+
the [Grafana Agent integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-grafana-agent/)
15+
available in Grafana Cloud.
16+
* dashboard variables
17+
* `table` panels
18+
* `timeseries` panels
19+
* `prometheus` queries
20+
* [`linux-node-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/go/linux-node-overview):
21+
* reproduction of the "Grafana Agent Overview" dashboard from
22+
the [Linux Server integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-linux-node/#dashboards)
23+
available in Grafana Cloud.
24+
* dashboard variables
25+
* dashboard links
26+
* `stat` panels
27+
* `table` panels
28+
* `timeseries` panels
29+
* `prometheus` queries
30+
* [`red-method`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/go/red-method):
31+
* example of a dashboard following
32+
the [RED method](https://grafana.com/blog/2018/08/02/the-red-method-how-to-instrument-your-services/#the-red-method)
+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
weight: 10
3+
---
4+
# Examples
5+
6+
A collection of sample Grafana dashboards written in Java is available in the [grafana/grafana-foundation-sdk](https://github.com/grafana/grafana-foundation-sdk/) repository.
7+
8+
Each example showcases different aspects of building dashboards as code:
9+
10+
* [`custom-panel`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/java/custom-panel): definition and usage of a _custom_ Panel type
11+
* [`custom-query`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/java/custom-query): definition and usage of a _custom_ Query type
12+
* [`grafana-agent-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/java/grafana-agent-overview):
13+
* reproduction of the "Grafana Agent Overview" dashboard from
14+
the [Grafana Agent integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-grafana-agent/)
15+
available in Grafana Cloud.
16+
* dashboard variables
17+
* `table` panels
18+
* `timeseries` panels
19+
* `prometheus` queries
20+
* [`linux-node-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/java/linux-node-overview):
21+
* reproduction of the "Grafana Agent Overview" dashboard from
22+
the [Linux Server integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-linux-node/#dashboards)
23+
available in Grafana Cloud.
24+
* dashboard variables
25+
* dashboard links
26+
* `stat` panels
27+
* `table` panels
28+
* `timeseries` panels
29+
* `prometheus` queries
30+
* [`red-method`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/java/red-method):
31+
* example of a dashboard following
32+
the [RED method](https://grafana.com/blog/2018/08/02/the-red-method-how-to-instrument-your-services/#the-red-method)
+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
weight: 10
3+
---
4+
# Examples
5+
6+
A collection of sample Grafana dashboards written in PHP is available in the [grafana/grafana-foundation-sdk](https://github.com/grafana/grafana-foundation-sdk/) repository.
7+
8+
Each example showcases different aspects of building dashboards as code:
9+
10+
* [`custom-panel`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/php/custom-panel): definition and usage of a _custom_ Panel type
11+
* [`custom-query`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/php/custom-query): definition and usage of a _custom_ Query type
12+
* [`grafana-agent-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/php/grafana-agent-overview):
13+
* reproduction of the "Grafana Agent Overview" dashboard from
14+
the [Grafana Agent integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-grafana-agent/)
15+
available in Grafana Cloud.
16+
* dashboard variables
17+
* `table` panels
18+
* `timeseries` panels
19+
* `prometheus` queries
20+
* [`linux-node-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/php/linux-node-overview):
21+
* reproduction of the "Grafana Agent Overview" dashboard from
22+
the [Linux Server integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-linux-node/#dashboards)
23+
available in Grafana Cloud.
24+
* dashboard variables
25+
* dashboard links
26+
* `stat` panels
27+
* `table` panels
28+
* `timeseries` panels
29+
* `prometheus` queries
30+
* [`red-method`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/php/red-method):
31+
* example of a dashboard following
32+
the [RED method](https://grafana.com/blog/2018/08/02/the-red-method-how-to-instrument-your-services/#the-red-method)
+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
weight: 10
3+
---
4+
# Examples
5+
6+
A collection of sample Grafana dashboards written in Python is available in the [grafana/grafana-foundation-sdk](https://github.com/grafana/grafana-foundation-sdk/) repository.
7+
8+
Each example showcases different aspects of building dashboards as code:
9+
10+
* [`custom-panel`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/python/custom-panel): definition and usage of a _custom_ Panel type
11+
* [`custom-query`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/python/custom-query): definition and usage of a _custom_ Query type
12+
* [`grafana-agent-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/python/grafana-agent-overview):
13+
* reproduction of the "Grafana Agent Overview" dashboard from
14+
the [Grafana Agent integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-grafana-agent/)
15+
available in Grafana Cloud.
16+
* dashboard variables
17+
* `table` panels
18+
* `timeseries` panels
19+
* `prometheus` queries
20+
* [`linux-node-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/python/linux-node-overview):
21+
* reproduction of the "Grafana Agent Overview" dashboard from
22+
the [Linux Server integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-linux-node/#dashboards)
23+
available in Grafana Cloud.
24+
* dashboard variables
25+
* dashboard links
26+
* `stat` panels
27+
* `table` panels
28+
* `timeseries` panels
29+
* `prometheus` queries
30+
* [`red-method`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/python/red-method):
31+
* example of a dashboard following
32+
the [RED method](https://grafana.com/blog/2018/08/02/the-red-method-how-to-instrument-your-services/#the-red-method)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
weight: 10
3+
---
4+
# Examples
5+
6+
A collection of sample Grafana dashboards written in TypeScript is available in the [grafana/grafana-foundation-sdk](https://github.com/grafana/grafana-foundation-sdk/) repository.
7+
8+
Each example showcases different aspects of building dashboards as code:
9+
10+
* [`custom-panel`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/typescript/custom-panel): definition and usage of a _custom_ Panel type
11+
* [`custom-query`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/typescript/custom-query): definition and usage of a _custom_ Query type
12+
* [`grafana-agent-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/typescript/grafana-agent-overview):
13+
* reproduction of the "Grafana Agent Overview" dashboard from
14+
the [Grafana Agent integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-grafana-agent/)
15+
available in Grafana Cloud.
16+
* dashboard variables
17+
* `table` panels
18+
* `timeseries` panels
19+
* `prometheus` queries
20+
* [`linux-node-overview`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/typescript/linux-node-overview):
21+
* reproduction of the "Grafana Agent Overview" dashboard from
22+
the [Linux Server integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-linux-node/#dashboards)
23+
available in Grafana Cloud.
24+
* dashboard variables
25+
* dashboard links
26+
* `stat` panels
27+
* `table` panels
28+
* `timeseries` panels
29+
* `prometheus` queries
30+
* [`red-method`](https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/typescript/red-method):
31+
* example of a dashboard following
32+
the [RED method](https://grafana.com/blog/2018/08/02/the-red-method-how-to-instrument-your-services/#the-red-method)

0 commit comments

Comments
 (0)