Skip to content

Commit 036f739

Browse files
Clarify the OnCall docs regarding teams (#639)
* Clarify the OnCall docs regarding teams Closes #637 `team_id` can be confusing. For OnCall, it refers to an OnCall team, not a Grafana team * Even clearer
1 parent 86b3bac commit 036f739

10 files changed

+10
-10
lines changed

docs/resources/oncall_escalation_chain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ resource "grafana_oncall_escalation_chain" "default" {
2828

2929
### Optional
3030

31-
- `team_id` (String) The ID of the team.
31+
- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
3232

3333
### Read-Only
3434

docs/resources/oncall_integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ resource "grafana_oncall_integration" "test-acc-integration" {
3434

3535
### Optional
3636

37-
- `team_id` (String) The id of the team.
37+
- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
3838
- `templates` (Block List, Max: 1) Jinja2 templates for Alert payload. (see [below for nested schema](#nestedblock--templates))
3939

4040
### Read-Only

docs/resources/oncall_on_call_shift.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ output "emea_weekday__rolling_users" {
107107
- `level` (Number) The priority level. The higher the value, the higher the priority.
108108
- `rolling_users` (List of Set of String) The list of lists with on-call users (for rolling_users event type)
109109
- `start_rotation_from_user_index` (Number) The index of the list of users in rolling_users, from which on-call rotation starts.
110-
- `team_id` (String) The ID of the team.
110+
- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
111111
- `time_zone` (String) The shift's timezone. Overrides schedule's timezone.
112112
- `users` (Set of String) The list of on-call users (for single_event and recurrent_event event type).
113113
- `week_start` (String) Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU

docs/resources/oncall_outgoing_webhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ resource "grafana_oncall_outgoing_webhook" "test-acc-outgoing_webhook" {
3434
- `data` (String) The data of the webhook.
3535
- `forward_whole_payload` (Boolean) Forwards whole payload of the alert to the webhook's url as POST data.
3636
- `password` (String) The auth data of the webhook. Used for Basic authentication
37-
- `team_id` (String) The ID of the team.
37+
- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
3838
- `user` (String) The auth data of the webhook. Used for Basic authentication.
3939

4040
### Read-Only

docs/resources/oncall_schedule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ resource "grafana_oncall_schedule" "example_schedule" {
5858
- `ical_url_primary` (String) The URL of the external calendar iCal file.
5959
- `shifts` (Set of String) The list of ID's of on-call shifts.
6060
- `slack` (Block List, Max: 1) The Slack-specific settings for a schedule. (see [below for nested schema](#nestedblock--slack))
61-
- `team_id` (String) The ID of the team.
61+
- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
6262
- `time_zone` (String) The schedule's time zone.
6363

6464
### Read-Only

grafana/resource_oncall_escalation_chain.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func ResourceOnCallEscalationChain() *schema.Resource {
3232
"team_id": {
3333
Type: schema.TypeString,
3434
Optional: true,
35-
Description: "The ID of the team.",
35+
Description: "The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.",
3636
},
3737
},
3838
}

grafana/resource_oncall_integration.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func ResourceOnCallIntegration() *schema.Resource {
6868
"team_id": {
6969
Type: schema.TypeString,
7070
Optional: true,
71-
Description: "The id of the team.",
71+
Description: "The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.",
7272
},
7373
"type": {
7474
Type: schema.TypeString,

grafana/resource_oncall_on_call_shift.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ func ResourceOnCallOnCallShift() *schema.Resource {
6464
"team_id": {
6565
Type: schema.TypeString,
6666
Optional: true,
67-
Description: "The ID of the team.",
67+
Description: "The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.",
6868
},
6969
"name": {
7070
Type: schema.TypeString,

grafana/resource_oncall_outgoing_webhook.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func ResourceOnCallOutgoingWebhook() *schema.Resource {
3232
"team_id": {
3333
Type: schema.TypeString,
3434
Optional: true,
35-
Description: "The ID of the team.",
35+
Description: "The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.",
3636
},
3737
"url": {
3838
Type: schema.TypeString,

grafana/resource_oncall_schedule.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func ResourceOnCallSchedule() *schema.Resource {
3939
"team_id": {
4040
Type: schema.TypeString,
4141
Optional: true,
42-
Description: "The ID of the team.",
42+
Description: "The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.",
4343
},
4444
"type": {
4545
Type: schema.TypeString,

0 commit comments

Comments
 (0)