From df3b815286d7b721aa67200f98b746e4a179e795 Mon Sep 17 00:00:00 2001 From: ruthnaebeck <19349244+ruthnaebeck@users.noreply.github.com> Date: Tue, 21 Jul 2020 15:42:55 -0400 Subject: [PATCH] DOCS-838 Template wording (#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 --- .../activemq_xml/data/conf.yaml.example | 8 +++--- .../airflow/data/conf.yaml.example | 8 +++--- .../ambari/data/conf.yaml.example | 8 +++--- .../apache/data/conf.yaml.example | 8 +++--- .../cisco_aci/data/conf.yaml.example | 4 +-- .../cloud_foundry_api/data/conf.yaml.example | 4 +-- .../consul/data/conf.yaml.example | 8 +++--- .../couch/data/conf.yaml.example | 8 +++--- .../configuration/instances/http.yaml | 8 +++--- .../configuration/instances/openmetrics.yaml | 19 +++++++------- .../druid/data/conf.yaml.example | 8 +++--- .../ecs_fargate/data/conf.yaml.example | 4 +-- .../elastic/data/conf.yaml.example | 8 +++--- .../envoy/data/conf.yaml.example | 8 +++--- .../fluentd/data/conf.yaml.example | 8 +++--- .../gitlab/data/conf.yaml.example | 25 +++++++++---------- .../hdfs_datanode/data/conf.yaml.example | 8 +++--- .../hdfs_namenode/data/conf.yaml.example | 8 +++--- .../istio/data/conf.yaml.example | 25 +++++++++---------- .../kong/data/conf.yaml.example | 8 +++--- .../data/conf.yaml.example | 25 +++++++++---------- .../lighttpd/data/conf.yaml.example | 8 +++--- .../nginx/data/conf.yaml.example | 8 +++--- .../data/conf.yaml.example | 25 +++++++++---------- .../openmetrics/data/conf.yaml.example | 25 +++++++++---------- .../spark/data/conf.yaml.example | 8 +++--- .../twistlock/data/conf.yaml.example | 8 +++--- .../vault/data/conf.yaml.example | 8 +++--- 28 files changed, 151 insertions(+), 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 index c06cd21b67c65..4758790eb5c16 100644 --- 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 index 1bab441173ea7..e151003259578 100644 --- 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 index 58493e508a2da..547f42e82b11a 100644 --- 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 index 917f19cda798f..ebc28f8ca3ad8 100644 --- 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 index d677b36edbadf..b444bd53572e3 100644 --- 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 index 9b75751a9201f..ed05d630e9551 100644 --- 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 index 891bee29db90d..df41b9ecd8040 100644 --- 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 index b072554288910..d79148e180198 100644 --- 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 index 0bd529bfa4882..2f9f172c2b2f8 100644 --- 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/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml index 9138d929421f7..f9add3e6f88b4 100644 --- a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml +++ b/datadog_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 .prometheus.health + Send a service check reporting about the health of the Prometheus endpoint. + The service check is named .prometheus.health value: type: boolean example: true @@ -44,7 +44,7 @@ example: