From 74a6959d4661c915824dfe8c73f31282b1b4de33 Mon Sep 17 00:00:00 2001 From: Julien Pivotto Date: Thu, 2 Jul 2020 23:27:14 +0200 Subject: [PATCH] Docs: fix types (#7508) I have batched a bunch of fixes around types in the documentation. Signed-off-by: Julien Pivotto --- docs/configuration/configuration.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md index 467714c1e..d7bf792f9 100644 --- a/docs/configuration/configuration.md +++ b/docs/configuration/configuration.md @@ -33,14 +33,15 @@ Generic placeholders are defined as follows: * ``: a boolean that can take the values `true` or `false` * ``: a duration matching the regular expression `[0-9]+(ms|[smhdwy])` -* ``: a string matching the regular expression `[a-zA-Z_][a-zA-Z0-9_]*` -* ``: a string of unicode characters * ``: a valid path in the current working directory * ``: a valid string consisting of a hostname or IP followed by an optional port number +* ``: an integer value +* ``: a string matching the regular expression `[a-zA-Z_][a-zA-Z0-9_]*` +* ``: a string of unicode characters * ``: a valid URL path * ``: a string that can take the values `http` or `https` -* ``: a regular string * ``: a regular string that is a secret, such as a password +* ``: a regular string * ``: a string which is template-expanded before usage The other placeholders are specified separately. @@ -376,7 +377,7 @@ tags: [ tag_separator: | default = , ] # Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. -[ allow_stale: | default = true ] +[ allow_stale: | default = true ] # The time after which the provided names are refreshed. # On large setup it might be a good idea to increase this value because the catalog will change all the time. @@ -598,7 +599,7 @@ names: [ type: | default = 'SRV' ] # The port number used if the query type is not SRV. -[ port: ] +[ port: ] # The time after which the provided names are refreshed. [ refresh_interval: | default = 30s ] @@ -1118,7 +1119,7 @@ servers: # password and password_file are mutually exclusive. basic_auth: [ username: ] - [ password: ] + [ password: ] [ password_file: ] # Sets the `Authorization` header on every request with @@ -1332,7 +1333,7 @@ prefix is guaranteed to never be used by Prometheus itself. [ regex: | default = (.*) ] # Modulus to take of the hash of the source label values. -[ modulus: ] +[ modulus: ] # Replacement value against which a regex replace is performed if the # regular expression matches. Regex capture groups are available. @@ -1402,7 +1403,7 @@ through the `__alerts_path__` label. [ timeout: | default = 10s ] # The api version of Alertmanager. -[ api_version: | default = v1 ] +[ api_version: | default = v1 ] # Prefix for the HTTP path alerts are pushed to. [ path_prefix: | default = / ] @@ -1415,7 +1416,7 @@ through the `__alerts_path__` label. # password and password_file are mutually exclusive. basic_auth: [ username: ] - [ password: ] + [ password: ] [ password_file: ] # Sets the `Authorization` header on every request with @@ -1516,7 +1517,7 @@ write_relabel_configs: # password and password_file are mutually exclusive. basic_auth: [ username: ] - [ password: ] + [ password: ] [ password_file: ] # Sets the `Authorization` header on every remote write request with @@ -1588,7 +1589,7 @@ required_matchers: # password and password_file are mutually exclusive. basic_auth: [ username: ] - [ password: ] + [ password: ] [ password_file: ] # Sets the `Authorization` header on every remote read request with