Skip to content

Commit 92e798e

Browse files
authored
Document version reqs for all alerting resources (#662)
1 parent cb61077 commit 92e798e

10 files changed

+38
-3
lines changed

docs/resources/contact_point.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ subcategory: "Alerting"
55
description: |-
66
Manages Grafana Alerting contact points.
77
Official documentation https://grafana.com/docs/grafana/next/alerting/contact-pointsHTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points
8+
This resource requires Grafana 9.1.0 or later.
89
---
910

1011
# grafana_contact_point (Resource)
@@ -14,6 +15,8 @@ Manages Grafana Alerting contact points.
1415
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/contact-points)
1516
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points)
1617

18+
This resource requires Grafana 9.1.0 or later.
19+
1720
## Example Usage
1821

1922
```terraform

docs/resources/message_template.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,20 @@
33
page_title: "grafana_message_template Resource - terraform-provider-grafana"
44
subcategory: "Alerting"
55
description: |-
6+
Manages Grafana Alerting message templates.
67
Official documentation https://grafana.com/docs/grafana/next/alerting/contact-points/message-templating/HTTP API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#templates
8+
This resource requires Grafana 9.1.0 or later.
79
---
810

911
# grafana_message_template (Resource)
1012

13+
Manages Grafana Alerting message templates.
14+
1115
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/contact-points/message-templating/)
1216
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#templates)
1317

18+
This resource requires Grafana 9.1.0 or later.
19+
1420
## Example Usage
1521

1622
```terraform

docs/resources/mute_timing.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,20 @@
33
page_title: "grafana_mute_timing Resource - terraform-provider-grafana"
44
subcategory: "Alerting"
55
description: |-
6+
Manages Grafana Alerting mute timings.
67
Official documentation https://grafana.com/docs/grafana/next/alerting/notifications/mute-timings/HTTP API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#mute-timings
8+
This resource requires Grafana 9.1.0 or later.
79
---
810

911
# grafana_mute_timing (Resource)
1012

13+
Manages Grafana Alerting mute timings.
14+
1115
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/notifications/mute-timings/)
1216
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#mute-timings)
1317

18+
This resource requires Grafana 9.1.0 or later.
19+
1420
## Example Usage
1521

1622
```terraform

docs/resources/notification_policy.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,19 @@ page_title: "grafana_notification_policy Resource - terraform-provider-grafana"
44
subcategory: "Alerting"
55
description: |-
66
Sets the global notification policy for Grafana. Note that this resource manages the entire notification policy tree, and will overwrite any existing policies.
7-
* Official documentation https://grafana.com/docs/grafana/latest/alerting/notifications/
8-
* HTTP API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#notification-policies
7+
Official documentation https://grafana.com/docs/grafana/latest/alerting/notifications/HTTP API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#notification-policies
8+
This resource requires Grafana 9.1.0 or later.
99
---
1010

1111
# grafana_notification_policy (Resource)
1212

1313
Sets the global notification policy for Grafana. Note that this resource manages the entire notification policy tree, and will overwrite any existing policies.
14+
1415
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/notifications/)
1516
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#notification-policies)
1617

18+
This resource requires Grafana 9.1.0 or later.
19+
1720
## Example Usage
1821

1922
```terraform

docs/resources/rule_group.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ subcategory: "Alerting"
55
description: |-
66
Manages Grafana Alerting rule groups.
77
Official documentation https://grafana.com/docs/grafana/latest/alerting/alerting-rulesHTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules
8+
This resource requires Grafana 9.1.0 or later.
89
---
910

1011
# grafana_rule_group (Resource)
@@ -14,6 +15,8 @@ Manages Grafana Alerting rule groups.
1415
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/alerting-rules)
1516
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules)
1617

18+
This resource requires Grafana 9.1.0 or later.
19+
1720
## Example Usage
1821

1922
```terraform

grafana/resource_alerting_contact_point.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Manages Grafana Alerting contact points.
3838
3939
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/contact-points)
4040
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points)
41+
42+
This resource requires Grafana 9.1.0 or later.
4143
`,
4244
CreateContext: createContactPoint,
4345
ReadContext: readContactPoint,

grafana/resource_alerting_message_template.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ import (
1212
func ResourceMessageTemplate() *schema.Resource {
1313
return &schema.Resource{
1414
Description: `
15+
Manages Grafana Alerting message templates.
16+
1517
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/contact-points/message-templating/)
1618
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#templates)
19+
20+
This resource requires Grafana 9.1.0 or later.
1721
`,
1822
CreateContext: createMessageTemplate,
1923
ReadContext: readMessageTemplate,

grafana/resource_alerting_mute_timing.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ import (
1414
func ResourceMuteTiming() *schema.Resource {
1515
return &schema.Resource{
1616
Description: `
17+
Manages Grafana Alerting mute timings.
18+
1719
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/notifications/mute-timings/)
1820
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#mute-timings)
19-
`,
21+
22+
This resource requires Grafana 9.1.0 or later.
23+
`,
2024

2125
CreateContext: createMuteTiming,
2226
ReadContext: readMuteTiming,

grafana/resource_alerting_notification_policy.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@ func ResourceNotificationPolicy() *schema.Resource {
1313
return &schema.Resource{
1414
Description: `
1515
Sets the global notification policy for Grafana. Note that this resource manages the entire notification policy tree, and will overwrite any existing policies.
16+
1617
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/notifications/)
1718
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#notification-policies)
19+
20+
This resource requires Grafana 9.1.0 or later.
1821
`,
1922

2023
CreateContext: createNotificationPolicy,

grafana/resource_alerting_rule_group.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Manages Grafana Alerting rule groups.
2121
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/alerting-rules)
2222
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules)
2323
24+
This resource requires Grafana 9.1.0 or later.
2425
`,
2526
CreateContext: createAlertRuleGroup,
2627
ReadContext: readAlertRuleGroup,

0 commit comments

Comments
 (0)