docs: removed code-style highlighting for commanad-line flags of VM components (#6147)

Using `sh` or `console` formatting doesn't do word-breaking on render. This makes flags description
harder to read, as users need to scroll the web page horizontally.
Removing the formatting renders the description with normal word-breaking.
This commit is contained in:
Denys Holius 2024-04-22 15:53:26 +03:00 committed by GitHub
parent bae3874e6a
commit 9bedbcfa2f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 9 additions and 9 deletions

View file

@ -2679,7 +2679,7 @@ Files included in each folder:
Pass `-help` to VictoriaMetrics in order to see the list of supported command-line flags with their description:
```sh
```
-bigMergeConcurrency int
Deprecated: this flag does nothing
-blockcache.missesBeforeCaching int

View file

@ -2687,7 +2687,7 @@ Files included in each folder:
Pass `-help` to VictoriaMetrics in order to see the list of supported command-line flags with their description:
```sh
```
-bigMergeConcurrency int
Deprecated: this flag does nothing
-blockcache.missesBeforeCaching int

View file

@ -1623,7 +1623,7 @@ It is safe sharing the collected profiles from security point of view, since the
`vmagent` can be fine-tuned with various command-line flags. Run `./vmagent -help` in order to see the full list of these flags with their descriptions and default values:
```sh
```
./vmagent -help
vmagent collects metrics data via popular data ingestion protocols and routes them to VictoriaMetrics.

View file

@ -965,7 +965,7 @@ command-line flags with their descriptions.
The shortlist of configuration flags is the following:
```sh
```
-clusterMode
If clusterMode is enabled, then vmalert automatically adds the tenant specified in config groups to -datasource.url, -remoteWrite.url and -remoteRead.url. See https://docs.victoriametrics.com/vmalert/#multitenancy . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise/
-configCheckInterval duration

View file

@ -1121,7 +1121,7 @@ It is safe sharing the collected profiles from security point of view, since the
Pass `-help` command-line arg to `vmauth` in order to see all the configuration options:
```sh
```
./vmauth -help
vmauth authenticates and authorizes incoming requests and proxies them to VictoriaMetrics.

View file

@ -304,7 +304,7 @@ Refer to the respective documentation for your object storage provider for more
Run `vmbackup -help` in order to see all the available options:
```sh
```
-concurrency int
The number of concurrent workers. Higher concurrency may reduce backup duration (default 10)
-configFilePath string

View file

@ -415,7 +415,7 @@ command-line flags with their descriptions.
The shortlist of configuration flags is the following:
```text
```
vmbackupmanager performs regular backups according to the provided configs.
subcommands:

View file

@ -273,7 +273,7 @@ Example usage for tokens issued by Google:
Below is the list of configuration flags (it can be viewed by running `./vmgateway -help`):
```sh
```
-auth.httpHeader string
HTTP header name to look for JWT authorization token (default "Authorization")
-auth.jwksEndpoints array

View file

@ -91,7 +91,7 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q
* Run `vmrestore -help` in order to see all the available options:
```sh
```
-concurrency int
The number of concurrent workers. Higher concurrency may reduce restore duration (default 10)
-configFilePath string