DOCS-838 Template wording (DataDog#7038)

* DOCS-838 Template wording * file sync * sync * jmx.yaml * http.yaml * updates * updates * updates * update * update * updates * update * rebase with master and update openmetrics * Sync config Co-authored-by: ChristineTChen <[email protected]>
sayap · Jul 21, 2020 · df3b815 · df3b815
1 parent 07c3b5e
commit df3b815
Show file tree

Hide file tree

Showing 28 changed files with 151 additions and 157 deletions.
diff --git a/activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example b/activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example
@@ -85,7 +85,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -221,7 +221,7 @@ instances:
     ## @param aws_host - string - optional
     ## If your services require AWS Signature Version 4 signing, set the host.
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -231,7 +231,7 @@ instances:
     ## If your services require AWS Signature Version 4 signing, set the service code. For a list
     ## of available service codes, see https://docs.aws.amazon.com/general/latest/gr/rande.html
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -251,7 +251,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #

diff --git a/airflow/datadog_checks/airflow/data/conf.yaml.example b/airflow/datadog_checks/airflow/data/conf.yaml.example
@@ -56,7 +56,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -192,7 +192,7 @@ instances:
     ## @param aws_host - string - optional
     ## If your services require AWS Signature Version 4 signing, set the host.
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -202,7 +202,7 @@ instances:
     ## If your services require AWS Signature Version 4 signing, set the service code. For a list
     ## of available service codes, see https://docs.aws.amazon.com/general/latest/gr/rande.html
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -222,7 +222,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #

diff --git a/ambari/datadog_checks/ambari/data/conf.yaml.example b/ambari/datadog_checks/ambari/data/conf.yaml.example
@@ -125,7 +125,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -221,7 +221,7 @@ instances:
     ## @param aws_host - string - optional
     ## If your services require AWS Signature Version 4 signing, set the host.
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -231,7 +231,7 @@ instances:
     ## If your services require AWS Signature Version 4 signing, set the service code. For a list
     ## of available service codes, see https://docs.aws.amazon.com/general/latest/gr/rande.html
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -251,7 +251,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #

diff --git a/apache/datadog_checks/apache/data/conf.yaml.example b/apache/datadog_checks/apache/data/conf.yaml.example
@@ -56,7 +56,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -192,7 +192,7 @@ instances:
     ## @param aws_host - string - optional
     ## If your services require AWS Signature Version 4 signing, set the host.
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -202,7 +202,7 @@ instances:
     ## If your services require AWS Signature Version 4 signing, set the service code. For a list
     ## of available service codes, see https://docs.aws.amazon.com/general/latest/gr/rande.html
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -222,7 +222,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #

diff --git a/cisco_aci/datadog_checks/cisco_aci/data/conf.yaml.example b/cisco_aci/datadog_checks/cisco_aci/data/conf.yaml.example
@@ -125,7 +125,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -164,7 +164,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #

diff --git a/cloud_foundry_api/datadog_checks/cloud_foundry_api/data/conf.yaml.example b/cloud_foundry_api/datadog_checks/cloud_foundry_api/data/conf.yaml.example
@@ -69,7 +69,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -108,7 +108,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #

diff --git a/consul/datadog_checks/consul/data/conf.yaml.example b/consul/datadog_checks/consul/data/conf.yaml.example
@@ -119,7 +119,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -255,7 +255,7 @@ instances:
     ## @param aws_host - string - optional
     ## If your services require AWS Signature Version 4 signing, set the host.
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -265,7 +265,7 @@ instances:
     ## If your services require AWS Signature Version 4 signing, set the service code. For a list
     ## of available service codes, see https://docs.aws.amazon.com/general/latest/gr/rande.html
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -285,7 +285,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #

diff --git a/couch/datadog_checks/couch/data/conf.yaml.example b/couch/datadog_checks/couch/data/conf.yaml.example
@@ -131,7 +131,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -257,7 +257,7 @@ instances:
     ## @param aws_host - string - optional
     ## If your services require AWS Signature Version 4 signing, set the host.
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -267,7 +267,7 @@ instances:
     ## If your services require AWS Signature Version 4 signing, set the service code. For a list
     ## of available service codes, see https://docs.aws.amazon.com/general/latest/gr/rande.html
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -287,7 +287,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #

diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/http.yaml b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/http.yaml
@@ -22,7 +22,7 @@
     Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     to specify hosts that must bypass proxies.
 
-    The SOCKS protocol is also supported like so:
+    The SOCKS protocol is also supported, for example:
 
       socks5://user:pass@host:port
 
@@ -159,7 +159,7 @@
   description: |
     If your services require AWS Signature Version 4 signing, set the host.
 
-    Note that this setting is not necessary for official integrations.
+    Note: This setting is not necessary for official integrations.
 
     See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
 - name: aws_service
@@ -169,7 +169,7 @@
     If your services require AWS Signature Version 4 signing, set the service code. For a list
     of available service codes, see https://docs.aws.amazon.com/general/latest/gr/rande.html
 
-    Note that this setting is not necessary for official integrations.
+    Note: This setting is not necessary for official integrations.
 
     See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
 - name: tls_verify
@@ -191,7 +191,7 @@
     If `tls_verify` is disabled, security warnings are logged by the check.
     Disable those by setting `tls_ignore_warning` to true.
 
-    Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     to true.
 - name: tls_cert

diff --git a/..._checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml b/..._checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml
@@ -32,8 +32,8 @@
     default: null
 - name: health_service_check
   description: |
-    Send a service check reporting about the health of the prometheus endpoint.
-    It's named <NAMESPACE>.prometheus.health
+    Send a service check reporting about the health of the Prometheus endpoint.
+    The service check is named <NAMESPACE>.prometheus.health
   value:
     type: boolean
     example: true
@@ -44,7 +44,7 @@
     example: <LABEL>
 - name: label_joins
   description: |
-    The label join allows to target a metric and retrieve it's label via a 1:1 mapping.
+    The label join allows to target a metric and retrieve it's label with a 1:1 mapping.
   value:
     example:
       target_metric:
@@ -73,9 +73,8 @@
     type: object
 - name: type_overrides
   description: |
-    Type override allows you to override a type in the prometheus payload
-    or type an untyped metrics (they're ignored by default).
-    Supported <METRIC_TYPE> are `gauge`, `counter`, `histogram`, `summary`
+    Override a type in the Prometheus payload or type an untyped metric (they're ignored by default).
+    Supported <METRIC_TYPE> are `gauge`, `counter`, `histogram`, and `summary`.
     The "*" wildcard can be used to match multiple metric names.
   value:
     example:
@@ -109,14 +108,14 @@
     type: boolean
 - name: send_distribution_counts_as_monotonic
   description: |
-    Set send_distribution_counts_as_monotonic to true to send histograms & summary
+    Set send_distribution_counts_as_monotonic to true to send histograms and summary
     counters as monotonic counters (instead of gauges).
   value:
     example: false
     type: boolean
 - name: send_distribution_sums_as_monotonic
   description: |
-    Set send_distribution_sums_as_monotonic to true to send histograms & summary
+    Set send_distribution_sums_as_monotonic to true to send histograms and summary
     sum as monotonic counters (instead of gauges).
   value:
     example: false
@@ -138,7 +137,7 @@
     type: boolean
 - name: bearer_token_path
   description: |
-    The path to a kubernetes service account bearer token file, make sure the file exists and mounted correctly.
+    The path to a Kubernetes service account bearer token file. Make sure the file exists and is mounted correctly.
     Note: bearer_token_auth should be set to true to enable adding the token to HTTP headers for authentication.
   value:
     example: <TOKEN_PATH>
@@ -157,4 +156,4 @@
       - <*_SUBSTRING_*>
 
 - template: instances/http
-- template: instances/default
+- template: instances/default
diff --git a/druid/datadog_checks/druid/data/conf.yaml.example b/druid/datadog_checks/druid/data/conf.yaml.example
@@ -56,7 +56,7 @@ instances:
     ## Set HTTP or HTTPS proxies for all instances. Use the `no_proxy` list
     ## to specify hosts that must bypass proxies.
     ##
-    ## The SOCKS protocol is also supported like so:
+    ## The SOCKS protocol is also supported, for example:
     ##
     ##   socks5://user:pass@host:port
     ##
@@ -192,7 +192,7 @@ instances:
     ## @param aws_host - string - optional
     ## If your services require AWS Signature Version 4 signing, set the host.
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -202,7 +202,7 @@ instances:
     ## If your services require AWS Signature Version 4 signing, set the service code. For a list
     ## of available service codes, see https://docs.aws.amazon.com/general/latest/gr/rande.html
     ##
-    ## Note that this setting is not necessary for official integrations.
+    ## Note: This setting is not necessary for official integrations.
     ##
     ## See https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
@@ -222,7 +222,7 @@ instances:
     ## If `tls_verify` is disabled, security warnings are logged by the check.
     ## Disable those by setting `tls_ignore_warning` to true.
     ##
-    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration. 
+    ## Note: `tls_ignore_warning` set to true is currently only reliable if used by one instance of one integration.
     ## If enabled for multiple instances, spurious warnings might still appear even if `tls_ignore_warning` is set
     ## to true.
     #