NSOF-5818 alert: fix documentation

Author: hod-alpert

docs/data-sources/alert.md

@@ -5,14 +5,14 @@ subcategory: "Notifications"
 description: |-
   Alerts let you monitor data including network traffic and activities, or various security events like password resets and missing certificates.
   You can examine and filter any type of event, as well as define alert notifications to be sent to email, webhooks (integrating with SaaS apps), PagerDuty or Slack.
-  Alerts can configure either spike_condition or threshold_condition
+  Alerts can be configured using either spike_condition or threshold_condition
 ---
 
 # pfptmeta_alert (Data Source)
 
 Alerts let you monitor data including network traffic and activities, or various security events like password resets and missing certificates.
 You can examine and filter any type of event, as well as define alert notifications to be sent to email, webhooks (integrating with SaaS apps), PagerDuty or Slack.
-Alerts can configure either `spike_condition` or `threshold_condition`
+Alerts can be configured using either `spike_condition` or `threshold_condition`
 
 ## Example Usage
 
@@ -44,16 +44,16 @@ output "alert" {
 	You can use free text and/or alert field names surrounded with a "${ }". For example, "${hits} have failed to login".
 - **query_text** (String)
 - **source_type** (String) Logs type. Supported log types:
-	- **security_audit**- The `security_audit` logs provide the administrator visibility into events which are generated by device and user security-related activity, such as user authenticating into Proofpoint NaaS, users changing their passwords, posture check failures, etc. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#security-logs) for more.
-	- **api_audit** - The `api_audit` logs captures details of administrator activity: the timestamp and identity of administrators who accessed the Proofpoint NaaS tenant, and configuration changes that were made by the administrator. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#audit-logs) for more.
-	- **traffic_audit** - The `traffic_audit` logs provide detailed visibility into each element in the system covering network traffic including DNS and other OSI Layer 3 and 4 traffic details. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#traffic-logs) for more.
-	- **metaproxy_audit** - The `metaproxy_audit` logs provide the administrator visibility into the clientless access from their employees into web applications configured via EasyLink policy. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#metaconnect-web-logs) for more.
-	- **webfilter_audit** - The `webfilter_audit` logs provide the administrator visibility into the events generated by the Web Security engine. See [here](https://help.metanetworks.com/knowledgebase/logs_ws/) for more
+	- **security_audit**- The `security_audit` logs provide the administrator visibility into events which are generated by device and user security-related activity, such as user authenticating into Proofpoint NaaS, users changing their passwords, posture check failures, etc. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#security-logs) for details.
+	- **api_audit** - The `api_audit` logs capture details of administrator activity: the timestamp and identity of administrators who accessed the Proofpoint NaaS tenant, and configuration changes that were made by the administrator. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#audit-logs) for details.
+	- **traffic_audit** - The `traffic_audit` logs provide detailed visibility into each element in the system covering network traffic including DNS and other OSI Layer 3 and 4 traffic details. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#traffic-logs) for details.
+	- **metaproxy_audit** - The `metaproxy_audit` logs provide the administrator visibility into the clientless access of their employees to web applications configured via EasyLink policy. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#metaconnect-web-logs) for details.
+	- **webfilter_audit** - The `webfilter_audit` logs provide the administrator visibility into the events generated by the Web Security engine. See [here](https://help.metanetworks.com/knowledgebase/logs_ws/) for details
 .
 - **spike_condition** (List of Object) (see [below for nested schema](#nestedatt--spike_condition))
 - **threshold_condition** (List of Object) (see [below for nested schema](#nestedatt--threshold_condition))
 - **type** (String)
-- **window** (Number) The time window of the check (in mins), ENUM: 1, 3, 5, 10, 30, 60, 360, 1440, 2880, 10080.
+- **window** (Number) The time window of the check (in mins), ENUM: `1`, `3`, `5`, `10`, `30`, `60`, `360`, `1440`, `2880`, `10080`.
 
 <a id="nestedatt--spike_condition"></a>
 ### Nested Schema for `spike_condition`

docs/resources/alert.md

@@ -5,14 +5,14 @@ subcategory: "Notifications"
 description: |-
   Alerts let you monitor data including network traffic and activities, or various security events like password resets and missing certificates.
   You can examine and filter any type of event, as well as define alert notifications to be sent to email, webhooks (integrating with SaaS apps), PagerDuty or Slack.
-  Alerts can configure either spike_condition or threshold_condition
+  Alerts can be configured using either spike_condition or threshold_condition
 ---
 
 # pfptmeta_alert (Resource)
 
 Alerts let you monitor data including network traffic and activities, or various security events like password resets and missing certificates.
 You can examine and filter any type of event, as well as define alert notifications to be sent to email, webhooks (integrating with SaaS apps), PagerDuty or Slack.
-Alerts can configure either `spike_condition` or `threshold_condition`
+Alerts can be configured using either `spike_condition` or `threshold_condition`
 
 ## Example Usage
 
@@ -66,13 +66,13 @@ resource "pfptmeta_alert" "threshold_condition_alert" {
 - **name** (String)
 - **query_text** (String)
 - **source_type** (String) Logs type. Supported log types:
-	- **security_audit**- The `security_audit` logs provide the administrator visibility into events which are generated by device and user security-related activity, such as user authenticating into Proofpoint NaaS, users changing their passwords, posture check failures, etc. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#security-logs) for more.
-	- **api_audit** - The `api_audit` logs captures details of administrator activity: the timestamp and identity of administrators who accessed the Proofpoint NaaS tenant, and configuration changes that were made by the administrator. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#audit-logs) for more.
-	- **traffic_audit** - The `traffic_audit` logs provide detailed visibility into each element in the system covering network traffic including DNS and other OSI Layer 3 and 4 traffic details. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#traffic-logs) for more.
-	- **metaproxy_audit** - The `metaproxy_audit` logs provide the administrator visibility into the clientless access from their employees into web applications configured via EasyLink policy. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#metaconnect-web-logs) for more.
-	- **webfilter_audit** - The `webfilter_audit` logs provide the administrator visibility into the events generated by the Web Security engine. See [here](https://help.metanetworks.com/knowledgebase/logs_ws/) for more
+	- **security_audit**- The `security_audit` logs provide the administrator visibility into events which are generated by device and user security-related activity, such as user authenticating into Proofpoint NaaS, users changing their passwords, posture check failures, etc. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#security-logs) for details.
+	- **api_audit** - The `api_audit` logs capture details of administrator activity: the timestamp and identity of administrators who accessed the Proofpoint NaaS tenant, and configuration changes that were made by the administrator. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#audit-logs) for details.
+	- **traffic_audit** - The `traffic_audit` logs provide detailed visibility into each element in the system covering network traffic including DNS and other OSI Layer 3 and 4 traffic details. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#traffic-logs) for details.
+	- **metaproxy_audit** - The `metaproxy_audit` logs provide the administrator visibility into the clientless access of their employees to web applications configured via EasyLink policy. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#metaconnect-web-logs) for details.
+	- **webfilter_audit** - The `webfilter_audit` logs provide the administrator visibility into the events generated by the Web Security engine. See [here](https://help.metanetworks.com/knowledgebase/logs_ws/) for details
 .
-- **window** (Number) The time window of the check (in mins), ENUM: 1, 3, 5, 10, 30, 60, 360, 1440, 2880, 10080.
+- **window** (Number) The time window of the check (in mins), ENUM: `1`, `3`, `5`, `10`, `30`, `60`, `360`, `1440`, `2880`, `10080`.
 
 ### Optional
 
@@ -94,9 +94,9 @@ resource "pfptmeta_alert" "threshold_condition_alert" {
 
 Required:
 
-- **spike_ratio** (Number) The diff between hits that triggers alert (in percents)
-- **spike_type** (String) Spike type, ENUM: "up", "down", "both".
-- **time_diff** (Number) Time difference in minutes between current and reference window, Enum: 1, 3, 5, 60, 1440, 10080.
+- **spike_ratio** (Number) The difference between hits that triggers alert (in percents).
+- **spike_type** (String) Spike type, ENUM: `up`, `down`, `both`.
+- **time_diff** (Number) Time difference in minutes between current and reference window, Enum: `1`, `3`, `5`, `60`, `1440`, `10080`.
 
 Optional:
 
@@ -108,9 +108,9 @@ Optional:
 
 Required:
 
-- **op** (String) Operator used to compare to the threshold, ENUM: "greater", "greaterequals", "less", "lessequals", "equals".
+- **op** (String) Operator used to compare to the threshold, ENUM: `greater`, `greaterequals`, `less`, `lessequals`, `equals`.
 - **threshold** (Number) The threshold to compare result of the formula.
 
 Optional:
 
-- **formula** (String) Mathematical formula to run on the events, ENUM: "count".
+- **formula** (String) Mathematical formula to run on the events, ENUM: `count`.

internal/provider/alert/common.go

@@ -11,25 +11,25 @@ import (
 const (
 	description = "Alerts let you monitor data including network traffic and activities, or various security events like password resets and missing certificates.\n" +
 		"You can examine and filter any type of event, as well as define alert notifications to be sent to email, webhooks (integrating with SaaS apps), PagerDuty or Slack.\n" +
-		"Alerts can configure either `spike_condition` or `threshold_condition`"
+		"Alerts can be configured using either `spike_condition` or `threshold_condition`"
 	channelsDesc      = "List of notification channel IDs."
 	groupByDesc       = "The group by field name."
 	notifyMessageDesc = "Creates a custom message that will be sent to your notification channels.\n" +
 		"	You can use free text and/or alert field names surrounded with a \"${ }\". For example, \"${hits} have failed to login\"."
 	sourceTypeDesc = "Logs type. Supported log types:\n" +
-		"	- **security_audit**- The `security_audit` logs provide the administrator visibility into events which are generated by device and user security-related activity, such as user authenticating into Proofpoint NaaS, users changing their passwords, posture check failures, etc. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#security-logs) for more.\n" +
-		"	- **api_audit** - The `api_audit` logs captures details of administrator activity: the timestamp and identity of administrators who accessed the Proofpoint NaaS tenant, and configuration changes that were made by the administrator. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#audit-logs) for more.\n" +
-		"	- **traffic_audit** - The `traffic_audit` logs provide detailed visibility into each element in the system covering network traffic including DNS and other OSI Layer 3 and 4 traffic details. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#traffic-logs) for more.\n" +
-		"	- **metaproxy_audit** - The `metaproxy_audit` logs provide the administrator visibility into the clientless access from their employees into web applications configured via EasyLink policy. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#metaconnect-web-logs) for more.\n" +
-		"	- **webfilter_audit** - The `webfilter_audit` logs provide the administrator visibility into the events generated by the Web Security engine. See [here](https://help.metanetworks.com/knowledgebase/logs_ws/) for more\n."
+		"	- **security_audit**- The `security_audit` logs provide the administrator visibility into events which are generated by device and user security-related activity, such as user authenticating into Proofpoint NaaS, users changing their passwords, posture check failures, etc. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#security-logs) for details.\n" +
+		"	- **api_audit** - The `api_audit` logs capture details of administrator activity: the timestamp and identity of administrators who accessed the Proofpoint NaaS tenant, and configuration changes that were made by the administrator. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#audit-logs) for details.\n" +
+		"	- **traffic_audit** - The `traffic_audit` logs provide detailed visibility into each element in the system covering network traffic including DNS and other OSI Layer 3 and 4 traffic details. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#traffic-logs) for details.\n" +
+		"	- **metaproxy_audit** - The `metaproxy_audit` logs provide the administrator visibility into the clientless access of their employees to web applications configured via EasyLink policy. See [here](https://help.metanetworks.com/knowledgebase/admin_console_logs/#metaconnect-web-logs) for details.\n" +
+		"	- **webfilter_audit** - The `webfilter_audit` logs provide the administrator visibility into the events generated by the Web Security engine. See [here](https://help.metanetworks.com/knowledgebase/logs_ws/) for details\n."
 	minHitsDesc    = "Minimum number of hits in current window to check the spike."
-	spikeRatioDesc = "The diff between hits that triggers alert (in percents)"
-	spikeTypeDesc  = "Spike type, ENUM: \"up\", \"down\", \"both\"."
-	timeDiffDesc   = "Time difference in minutes between current and reference window, Enum: 1, 3, 5, 60, 1440, 10080."
-	formulaDesc    = "Mathematical formula to run on the events, ENUM: \"count\"."
-	opDesc         = "Operator used to compare to the threshold, ENUM: \"greater\", \"greaterequals\", \"less\", \"lessequals\", \"equals\"."
+	spikeRatioDesc = "The difference between hits that triggers alert (in percents)."
+	spikeTypeDesc  = "Spike type, ENUM: `up`, `down`, `both`."
+	timeDiffDesc   = "Time difference in minutes between current and reference window, Enum: `1`, `3`, `5`, `60`, `1440`, `10080`."
+	formulaDesc    = "Mathematical formula to run on the events, ENUM: `count`."
+	opDesc         = "Operator used to compare to the threshold, ENUM: `greater`, `greaterequals`, `less`, `lessequals`, `equals`."
 	thresholdDesc  = "The threshold to compare result of the formula."
-	windowDesc     = "The time window of the check (in mins), ENUM: 1, 3, 5, 10, 30, 60, 360, 1440, 2880, 10080."
+	windowDesc     = "The time window of the check (in mins), ENUM: `1`, `3`, `5`, `10`, `30`, `60`, `360`, `1440`, `2880`, `10080`."
 )
 
 var excludedKeys = []string{"id", "spike_condition", "threshold_condition"}