more docs

Author: obeleh

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
       - id: tflint
       - id: shellcheck
   - repo: [email protected]:kabisa/terraform-datadog-pre-commit-hook.git
-    rev: "1.2.0"
+    rev: "1.2.2"
     hooks:
       - id: terraform-datadog-docs
         exclude: ^README.md$

README.md

@@ -10,6 +10,30 @@ It has basic SQL Server monitoring. Locks, process blocked, connectivity.
 It's best to also use Datadog's APM instrumentation to understand the way the application is using the database.
 There's an upcoming feature in Datadog to fully support deep dive database monitoring.
 
+This module is part of a larger suite of modules that provide alerts in Datadog.
+Other modules can be found on the [Terraform Registry](https://registry.terraform.io/search/modules?namespace=kabisa&provider=datadog)
+
+We have two base modules we use to standardise development of our Monitor Modules:
+- [generic monitor](https://github.com/kabisa/terraform-datadog-generic-monitor) Used in 90% of our alerts
+- [service check monitor](https://github.com/kabisa/terraform-datadog-service-check-monitor)
+
+Modules are generated with this tool: https://github.com/kabisa/datadog-terraform-generator
+
+# Example Usage
+
+```terraform
+module "kubernetes" {
+  source = "kabisa/sql-server/datadog"
+
+  notification_channel       = "[email protected]"
+  service                    = "SQL Server"
+  env                        = "prd"
+  alert_env                  = "prd"
+  filter_str                 = "role:sqlserver"
+  service_check_include_tags = ["role:sqlserver"]
+}
+```
+
 Monitors:
 * [Terraform module for Datadog Sql Server](#terraform-module-for-datadog-sql-server)
   * [Connections](#connections)

examples/example.tf

@@ -0,0 +1,10 @@
+module "kubernetes" {
+  source = "kabisa/sql-server/datadog"
+
+  notification_channel       = "[email protected]"
+  service                    = "SQL Server"
+  env                        = "prd"
+  alert_env                  = "prd"
+  filter_str                 = "role:sqlserver"
+  service_check_include_tags = ["role:sqlserver"]
+}