Add tfplugindocs scaffolding and generate monitor docs (#839)

* Add tfplugindocs scaffolding and generate monitor docs

* Update examples/resources/datadog_monitor/resource.tf

Co-authored-by: Hippolyte HENRY <[email protected]>

* Cleanup and add docs guide generation

Co-authored-by: Hippolyte HENRY <[email protected]>

Author: nmuesch

datadog/resource_datadog_monitor.go

@@ -65,7 +65,7 @@ func resourceDatadogMonitor() *schema.Resource {
 				},
 			},
 			"type": {
-				Description:  "The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API [documentation page](https://docs.datadoghq.com/api/v1/monitors/#create-a-monitor). The available options are below. Note: The monitor type cannot be changed after a monitor is created.",
+				Description:  "The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API [documentation page](https://docs.datadoghq.com/api/v1/monitors/#create-a-monitor). Note: The monitor type cannot be changed after a monitor is created.",
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,

docs/data-sources/monitor.md

@@ -1,49 +1,75 @@
 ---
-page_title: "datadog_monitor"
+page_title: "datadog_monitor Data Source - terraform-provider-datadog"
+subcategory: ""
+description: |-
+  Use this data source to retrieve information about an existing monitor for use in other resources.
 ---
 
-# datadog_monitor Data Source
+# Data Source `datadog_monitor`
 
 Use this data source to retrieve information about an existing monitor for use in other resources.
 
 ## Example Usage
 
-```
+```terraform
 data "datadog_monitor" "test" {
   name_filter = "My awesome monitor"
   monitor_tags_filter = ["foo:bar"]
 }
 ```
 
-## Argument Reference
-
--   `name_filter`: (Optional) A monitor name to limit the search.
--   `tags_filter`: (Optional) A list of tags to limit the search. This filters on the monitor scope.
--   `monitor_tags_filter`: (Optional) A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
-
-~> **NOTE:** If more or less than a single match is returned by the search, Terraform will fail. Ensure that your search is specific enough to return a single monitor.
-
-## Attributes Reference
-
--   `id`: ID of the Datadog monitor
--   `name`: Name of the monitor.
--   `type`: Type of the monitor.
--   `query`: Query of the monitor.
--   `message`: Message included with notifications for this monitor.
--   `escalation_message`: Message included with a re-notification for this monitor.
--   `thresholds`: (Deprecated) Alert thresholds of the monitor. Use `monitor_thresholds` instead.
--   `monitor_thresholds`: Alert thresholds of the monitor. List of one element containing the threshold definitions.
--   `notify_no_data`: Whether or not this monitor notifies when data stops reporting.
--   `new_host_delay`: Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
--   `evaluation_delay`: Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
--   `no_data_timeframe`: The number of minutes before the monitor notifies when data stops reporting.
--   `renotify_interval`: The number of minutes after the last notification before the monitor re-notifies on the current status.
--   `notify_audit`: Whether or not tagged users are notified on changes to the monitor.
--   `timeout_h`: Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
--   `include_tags`: Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
--   `enable_logs_sample`: Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
--   `require_full_window`: Whether or not the monitor needs a full window of data before it is evaluated.
--   `locked`: Whether or not changes to the monitor are restricted to the creator or admins.
--   `tags`: List of tags associated with the monitor.
--   `threshold_windows`: (Deprecated) Mapping containing `recovery_window` and `trigger_window` values, e.g. `last_15m`. This is only used by anomaly monitors. Use `monitor_threshold_windows` instead.
--   `monitor_threshold_windows`: Mapping containing `recovery_window` and `trigger_window` values, e.g. `last_15m`. This is only used by anomaly monitors. List of one element containing the threshold window definitions.
+## Schema
+
+### Optional
+
+- **id** (String) The ID of this resource.
+- **monitor_tags_filter** (List of String) A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
+- **name_filter** (String) A monitor name to limit the search.
+- **tags_filter** (List of String) A list of tags to limit the search. This filters on the monitor scope.
+
+### Read-only
+
+- **enable_logs_sample** (Boolean) Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
+- **escalation_message** (String) Message included with a re-notification for this monitor.
+- **evaluation_delay** (Number) Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
+- **include_tags** (Boolean) Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
+- **locked** (Boolean) Whether or not changes to the monitor are restricted to the creator or admins.
+- **message** (String) Message included with notifications for this monitor
+- **monitor_threshold_windows** (List of Object) Mapping containing `recovery_window` and `trigger_window` values, e.g. `last_15m`. This is only used by anomaly monitors. (see [below for nested schema](#nestedatt--monitor_threshold_windows))
+- **monitor_thresholds** (List of Object) Alert thresholds of the monitor. (see [below for nested schema](#nestedatt--monitor_thresholds))
+- **name** (String) Name of the monitor
+- **new_host_delay** (Number) Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
+- **no_data_timeframe** (Number) The number of minutes before the monitor notifies when data stops reporting.
+- **notify_audit** (Boolean) Whether or not tagged users are notified on changes to the monitor.
+- **notify_no_data** (Boolean) Whether or not this monitor notifies when data stops reporting.
+- **query** (String) Query of the monitor.
+- **renotify_interval** (Number) The number of minutes after the last notification before the monitor re-notifies on the current status.
+- **require_full_window** (Boolean) Whether or not the monitor needs a full window of data before it is evaluated.
+- **tags** (Set of String) List of tags associated with the monitor.
+- **threshold_windows** (Map of String, Deprecated) Mapping containing `recovery_window` and `trigger_window` values, e.g. `last_15m`. This is only used by anomaly monitors.
+- **thresholds** (Map of String, Deprecated) Alert thresholds of the monitor.
+- **timeout_h** (Number) Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
+- **type** (String) Type of the monitor.
+
+<a id="nestedatt--monitor_threshold_windows"></a>
+### Nested Schema for `monitor_threshold_windows`
+
+Read-only:
+
+- **recovery_window** (String)
+- **trigger_window** (String)
+
+
+<a id="nestedatt--monitor_thresholds"></a>
+### Nested Schema for `monitor_thresholds`
+
+Read-only:
+
+- **critical** (String)
+- **critical_recovery** (String)
+- **ok** (String)
+- **unknown** (String)
+- **warning** (String)
+- **warning_recovery** (String)
+
+

docs/guides/monitors.md

@@ -1,14 +1,30 @@
 ---
-page_title: "datadog_monitor Resource Examples"
+subcategory: ""
+page_title: "Monitor Resource Examples"
+description: |-
+    Monitor Resource Examples
 ---
 
-## Monitor Resource Examples
+### Monitor Resource Examples
 
 This page lists examples of how to create different Datadog monitor types within Terraform. This list is non exhaustive and will be updated over time to provide more examples.
 
-## Watchdog Monitors
+## Composite Monitors
+
+You can compose monitors of all types in order to define more specific alert conditions (see the [doc](https://docs.datadoghq.com/monitors/monitor_types/composite/)). You just need to reuse the ID of your `datadog_monitor` resources. You can also compose any monitor with a `datadog_synthetics_test` by passing the computed `monitor_id` attribute in the query.
 
+```terraform
+resource "datadog_monitor" "bar" {
+  name = "Composite Monitor"
+  type = "composite"
+  message = "This is a message"
+  query = "${datadog_monitor.foo.id} || ${datadog_synthetics_test.foo.monitor_id}"
+}
 ```
+
+## Watchdog Monitors
+
+```terraform
 resource "datadog_monitor" "watchdog_monitor" {
   name               = "Watchdog Monitor TF"
   type               = "event alert"
@@ -30,7 +46,7 @@ resource "datadog_monitor" "watchdog_monitor" {
 
 ## Anomaly Monitors
 
-```
+```terraform
 resource "datadog_monitor" "cpu_anomalous" {
   name = "Anomalous CPU usage"
   type = "query alert"
@@ -52,7 +68,7 @@ resource "datadog_monitor" "cpu_anomalous" {
 
 ## Process Monitors
 
-```
+```terraform
 resource "datadog_monitor" "process_alert_example" {
   name = "Process Alert Monitor"
   type = "process alert"