Merge pull request #146 from StatusCakeDev/improve-documentation

Improve documentation
StatusCakeDev · Sep 21, 2023 · 3e55fb4 · 3e55fb4
2 parents f8c6c12 + a32301d
commit 3e55fb4
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/docs/resources/pagespeed_check.md b/docs/resources/pagespeed_check.md
@@ -41,7 +41,7 @@ output "example_com_pagespeed_check_id" {
 
 ### Required
 
-- `alert_config` (Block List, Min: 1, Max: 1) Alert configuration block. Omitting this block disabled all alerts (see [below for nested schema](#nestedblock--alert_config))
+- `alert_config` (Block List, Min: 1, Max: 1) Alert configuration block. An empty block disables all alerts (see [below for nested schema](#nestedblock--alert_config))
 - `check_interval` (Number) Number of seconds between checks
 - `monitored_resource` (Block List, Min: 1, Max: 1) Monitored resource configuration block. This describes the server under test (see [below for nested schema](#nestedblock--monitored_resource))
 - `name` (String) Name of the check

diff --git a/examples/resources/statuscake_heartbeat_check/resource.tf b/examples/resources/statuscake_heartbeat_check/resource.tf
@@ -0,0 +1,20 @@
+resource "statuscake_uptime_check" "example" {
+  name   = "Example"
+  period = 1800
+
+  contact_groups = [
+    statuscake_contact_group.operations_team.id
+  ]
+
+  tags = [
+    "production",
+  ]
+}
+
+output "example_heartbeat_check_id" {
+  value = statuscake_heartbeat_check.example.id
+}
+
+output "example_heartbeat_check_url" {
+  value = statuscake_heartbeat_check.example.check_url
+}
diff --git a/internal/provider/resource_pagespeed_check.go b/internal/provider/resource_pagespeed_check.go
@@ -32,7 +32,7 @@ func resourceStatusCakePagespeedCheck() *schema.Resource {
 				Type:        schema.TypeList,
 				Required:    true,
 				MaxItems:    1,
-				Description: "Alert configuration block. Omitting this block disabled all alerts",
+				Description: "Alert configuration block. An empty block disables all alerts",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"alert_bigger": &schema.Schema{