Grammar fixes in the config files (#21756)

* fix grammar in config

* changelog

* Update consul/assets/configuration/spec.yaml

Co-authored-by: Brett Blue <[email protected]>

* Update consul/datadog_checks/consul/data/conf.yaml.example

Co-authored-by: Brett Blue <[email protected]>

---------

Co-authored-by: Brett Blue <[email protected]>

Author: steveny91

consul/assets/configuration/spec.yaml

@@ -12,9 +12,8 @@ files:
       display_priority: 2
       required: true
       description: |
-        Where your Consul HTTP server lives,
-        point the URL at the leader to get metrics about your Consul cluster.
-        Use HTTPS instead of HTTP if your Consul setup is configured to do so.
+        The URL of your Consul HTTP server. Point it at the leader to get metrics
+        about your Consul cluster. Use HTTPS if your Consul setup supports it.
       value:
         type: string
         example: http://localhost:8500
@@ -32,8 +31,8 @@ files:
         example: false
     - name: network_latency_checks
       description: |
-        Whether to enable network latency metrics collection. When enabled
-        Consul network coordinates is retrieved and latency calculated for
+        Whether to enable network latency metric collection. When enabled, Consul
+        network coordinates are retrieved and latency is calculated for
         each node and between data centers.
         See https://www.consul.io/docs/internals/coordinates.html
       value:
@@ -52,11 +51,11 @@ files:
 
     - name: self_leader_check
       description: |
-        Whether to enable self leader checks. Each instance with this enabled
-        watches for itself to become the leader and emits an event when that
-        happens. It is safe/expected to enable this on all nodes in a Consul
-        cluster since only the new leader emits the (single) event. This
-        flag takes precedence over new_leader_checks.
+        Whether to enable self-leader checks. Each enabled instance watches for
+        when it becomes the leader and emits an event when that happens. It is
+        safe and expected to enable this on all nodes in a Consul cluster since
+        only the new leader emits the event. This flag takes precedence over
+        new_leader_checks.
       value:
         type: boolean
         example: false
@@ -69,27 +68,27 @@ files:
 
     - name: single_node_install
       description: |
-        Whether or not to perform the full check even when not the leader. Useful
-        if you don't want to install the Agent on every node in a data center.
+        Whether to perform the full check even when this node is not the leader.
+        Useful if you don't want to install the Agent on every node in a data center.
       value:
         type: boolean
         example: false
 
     - name: new_leader_checks
       description: |
-        Whether to enable new leader checks from this instance
-        Note: If this is set on multiple instances or Agents in the same cluster
-        you receive one event per leader change per instance. See
+        Whether to enable new-leader checks from this instance.
+        Note: If this is set on multiple instances or Agents in the same cluster,
+        you will receive one event per leader change per instance. See
         self_leader_check for a more robust option.
       value:
         type: boolean
         example: false
 
     - name: services_include
       description: |
-        Services to restrict catalog querying to
-        the default settings query up to 50 services. If you have more than
-        services in your Consul service catalog, use this include list.
+        Services to which catalog querying is restricted. By default, the check
+        queries up to 50 services. If you have more than 50 services in your
+        Consul service catalog, use this include list.
       value:
         type: array
         items:
@@ -120,7 +119,7 @@ files:
 
     - name: threads_count
       description: |
-        Increase the number of threads to collect consul services checks.
+        Increase the number of threads used to collect Consul service checks.
       value:
         type: number
         example: 1

consul/changelog.d/21756.fixed

@@ -0,0 +1 @@
+Grammar fixes in the config files

consul/datadog_checks/consul/data/conf.yaml.example

@@ -46,9 +46,8 @@ init_config:
 instances:
 
     ## @param url - string - required
-    ## Where your Consul HTTP server lives,
-    ## point the URL at the leader to get metrics about your Consul cluster.
-    ## Use HTTPS instead of HTTP if your Consul setup is configured to do so.
+    ## The URL of your Consul HTTP server. Point it at the leader to get metrics
+    ## about your Consul cluster. Use HTTPS if your Consul setup supports it.
     #
   - url: http://localhost:8500
 
@@ -70,8 +69,8 @@ instances:
     # catalog_checks: false
 
     ## @param network_latency_checks - boolean - optional - default: false
-    ## Whether to enable network latency metrics collection. When enabled
-    ## Consul network coordinates is retrieved and latency calculated for
+    ## Whether to enable network latency metric collection. When enabled, Consul
+    ## network coordinates are retrieved and latency is calculated for
     ## each node and between data centers.
     ## See https://www.consul.io/docs/internals/coordinates.html
     #
@@ -87,11 +86,11 @@ instances:
     # use_node_name_as_hostname: true
 
     ## @param self_leader_check - boolean - optional - default: false
-    ## Whether to enable self leader checks. Each instance with this enabled
-    ## watches for itself to become the leader and emits an event when that
-    ## happens. It is safe/expected to enable this on all nodes in a Consul
-    ## cluster since only the new leader emits the (single) event. This
-    ## flag takes precedence over new_leader_checks.
+    ## Whether to enable self-leader checks. Each enabled instance watches for
+    ## when it becomes the leader and emits an event when that happens. It is
+    ## safe and expected to enable this on all nodes in a Consul cluster since
+    ## only the new leader emits the event. This flag takes precedence over
+    ## new_leader_checks.
     #
     # self_leader_check: false
 
@@ -101,23 +100,23 @@ instances:
     # acl_token: <ACL_TOKEN>
 
     ## @param single_node_install - boolean - optional - default: false
-    ## Whether or not to perform the full check even when not the leader. Useful
-    ## if you don't want to install the Agent on every node in a data center.
+    ## Whether to perform the full check even when this node is not the leader.
+    ## Useful if you don't want to install the Agent on every node in a data center.
     #
     # single_node_install: false
 
     ## @param new_leader_checks - boolean - optional - default: false
-    ## Whether to enable new leader checks from this instance
-    ## Note: If this is set on multiple instances or Agents in the same cluster
-    ## you receive one event per leader change per instance. See
+    ## Whether to enable new-leader checks from this instance.
+    ## Note: If this is set on multiple instances or Agents in the same cluster,
+    ## you will receive one event per leader change per instance. See
     ## self_leader_check for a more robust option.
     #
     # new_leader_checks: false
 
     ## @param services_include - list of strings - optional
-    ## Services to restrict catalog querying to
-    ## the default settings query up to 50 services. If you have more than
-    ## services in your Consul service catalog, use this include list.
+    ## Services to which catalog querying is restricted. By default, the check
+    ## queries up to 50 services. If you have more than 50 services in your
+    ## Consul service catalog, use this include list.
     #
     # services_include:
     #   - <SERVICE_1>
@@ -138,7 +137,7 @@ instances:
     # max_services: 50
 
     ## @param threads_count - number - optional - default: 1
-    ## Increase the number of threads to collect consul services checks.
+    ## Increase the number of threads used to collect Consul service checks.
     #
     # threads_count: 1