fix up docs from feedback

Signed-off-by: erikbaranowski <[email protected]>
grafana · Feb 7, 2024 · 162139f · 162139f
1 parent d9fe712
commit 162139f
Show file tree

Hide file tree

Showing 37 changed files with 112 additions and 108 deletions.
diff --git a/docs/sources/flow/reference/components/discovery.azure.md b/docs/sources/flow/reference/components/discovery.azure.md
@@ -33,8 +33,8 @@ Name                     | Type                | Description
 `subscription_id`        | `string`            | Azure subscription ID.                                                 |                      | no
 `refresh_interval`       | `duration`          | Interval at which to refresh the list of targets.                      | `5m`                 | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                                   |                      | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                         |                      | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.                      | `false`              | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.                  | `false`              | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests.          |                      | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.           | `true`               | no
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                               | `true`               | no

diff --git a/docs/sources/flow/reference/components/discovery.consul.md b/docs/sources/flow/reference/components/discovery.consul.md
@@ -48,11 +48,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.digitalocean.md b/docs/sources/flow/reference/components/discovery.digitalocean.md
@@ -36,8 +36,8 @@ Name                     | Type                | Description
 `bearer_token`           | `secret`            | Bearer token to authenticate with.                            |         | no
 `bearer_token_file`      | `string`            | File containing a bearer token to authenticate with.          |         | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no

diff --git a/docs/sources/flow/reference/components/discovery.docker.md b/docs/sources/flow/reference/components/discovery.docker.md
@@ -38,11 +38,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.dockerswarm.md b/docs/sources/flow/reference/components/discovery.dockerswarm.md
@@ -37,11 +37,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.ec2.md b/docs/sources/flow/reference/components/discovery.ec2.md
@@ -41,11 +41,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.eureka.md b/docs/sources/flow/reference/components/discovery.eureka.md
@@ -36,11 +36,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.hetzner.md b/docs/sources/flow/reference/components/discovery.hetzner.md
@@ -39,13 +39,13 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
 `role` must be one of `robot` or `hcloud`.
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments). 
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.http.md b/docs/sources/flow/reference/components/discovery.http.md
@@ -99,11 +99,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.ionos.md b/docs/sources/flow/reference/components/discovery.ionos.md
@@ -37,11 +37,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.kubelet.md b/docs/sources/flow/reference/components/discovery.kubelet.md
@@ -43,8 +43,8 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
 The `namespaces` list limits the namespaces to discover resources in. If
@@ -54,7 +54,7 @@ omitted, all namespaces are searched.
 You can have additional paths in the `url`.
 For example, if `url` is `https://kubernetes.default.svc.cluster.local:443/api/v1/nodes/cluster-node-1/proxy`, then `discovery.kubelet` sends a request on `https://kubernetes.default.svc.cluster.local:443/api/v1/nodes/cluster-node-1/proxy/pods`
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.kubernetes.md b/docs/sources/flow/reference/components/discovery.kubernetes.md
@@ -41,11 +41,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.kuma.md b/docs/sources/flow/reference/components/discovery.kuma.md
@@ -37,11 +37,11 @@ Name                     | Type                | Description
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                       | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.   | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                           |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                 |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.              | `false` | no
-`proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests.  |         | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
+`proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
- At most one of the following can be provided:
+ At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments). 
  - [`basic_auth` block][basic_auth].

diff --git a/docs/sources/flow/reference/components/discovery.lightsail.md b/docs/sources/flow/reference/components/discovery.lightsail.md
@@ -39,11 +39,11 @@ Name | Type | Description | Default | Required
 `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                      | `true`  | no
 `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.  | `true`  | no
 `proxy_url`              | `string`            | HTTP proxy to send requests through.                          |         | no
-`no_proxy`               | `string`            | Comma-separated list to exclude from proxying.                |         | no
-`proxy_from_environment` | `bool`              | Use proxy URL indicated by environment variables.             | `false` | no
+`no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no
+`proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.         | `false` | no
 `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. |         | no
 
-At most one of the following can be provided:
+At most, one of the following can be provided:
  - [`bearer_token` argument](#arguments).
  - [`bearer_token_file` argument](#arguments).
  - [`basic_auth` block][basic_auth].