chore: add docs examples

statusflare-com · May 17, 2021 · f16eb98 · f16eb98
1 parent 99ea7fc
commit f16eb98
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 30 deletions.
diff --git a/docs/data-sources/integration.md b/docs/data-sources/integration.md
@@ -10,7 +10,22 @@ description: |-
 
 
 
+## Example Usage
 
+```terraform
+data "statusflare_integration" "example" {
+  name = "example-integration-name"
+}
+
+resource "statusflare_monitor" "example" {
+  name = "Example monitor"
+  url  = "www.example.com"
+  
+  integrations = [
+    data.statusflare_integration.example.id
+  ]
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/index.md b/docs/index.md
@@ -16,8 +16,8 @@ description: |-
 terraform {
   required_providers {
     statusflare = {
-      version = "~> 1.0"
-      source  = "statusflare.com/statusflare/statusflare"
+      version = "~> 0.1"
+      source  = "statusflare-com/statusflare"
     }
   }
 }

diff --git a/docs/resources/integration.md b/docs/resources/integration.md
@@ -10,7 +10,15 @@ description: |-
 
 
 
-
+## Example Usage
+
+```terraform
+resource "statusflare_integration" "example" {
+  name   = "example-integration-name"
+  type   = "webhook"
+  secret = "https://webhook.example.com"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/resources/monitor.md b/docs/resources/monitor.md
@@ -10,7 +10,18 @@ description: |-
 
 
 
+## Example Usage
 
+```terraform
+resource "statusflare_monitor" "example" {
+  name = "Example monitor"
+  url  = "www.example.com"
+  
+  integrations = [
+    data.statusflare_integration.slack.id
+  ]
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/examples/data-sources/statusflare_integration/data-source.tf b/examples/data-sources/statusflare_integration/data-source.tf
@@ -0,0 +1,12 @@
+data "statusflare_integration" "example" {
+  name = "example-integration-name"
+}
+
+resource "statusflare_monitor" "example" {
+  name = "Example monitor"
+  url  = "www.example.com"
+
+  integrations = [
+    data.statusflare_integration.example.id
+  ]
+}
diff --git a/examples/main.tf b/examples/main.tf
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,8 +1,8 @@
 terraform {
   required_providers {
     statusflare = {
-      version = "~> 1.0"
-      source  = "statusflare.com/statusflare/statusflare"
+      version = "~> 0.1"
+      source  = "statusflare-com/statusflare"
     }
   }
 }
@@ -12,5 +12,3 @@ provider "statusflare" {
   key_id     = "..."
   token      = "***"
 }
-
-
diff --git a/examples/resources/statusflare_integration/resource.tf b/examples/resources/statusflare_integration/resource.tf
@@ -0,0 +1,5 @@
+resource "statusflare_integration" "example" {
+  name   = "example-integration-name"
+  type   = "webhook"
+  secret = "https://webhook.example.com"
+}
diff --git a/examples/resources/statusflare_monitor/resource.tf b/examples/resources/statusflare_monitor/resource.tf
@@ -0,0 +1,8 @@
+resource "statusflare_monitor" "example" {
+  name = "Example monitor"
+  url  = "www.example.com"
+
+  integrations = [
+    data.statusflare_integration.slack.id
+  ]
+}