From 7ecf68093f74d258ef53b4793ca712d96170515e Mon Sep 17 00:00:00 2001 From: Andrii Chubatiuk Date: Tue, 22 Oct 2024 13:00:07 +0300 Subject: [PATCH] docs: updated cmd flags highlight style (#7312) ### Describe Your Changes Changed highlight style for cmd flags ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --- docs/Cluster-VictoriaMetrics.md | 2 +- docs/README.md | 2 +- docs/vmagent.md | 2 +- docs/vmalert.md | 2 +- docs/vmauth.md | 2 +- docs/vmbackup.md | 2 +- docs/vmgateway.md | 2 +- docs/vmrestore.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index e3a59bfa7..781485a2e 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -1091,7 +1091,7 @@ Report bugs and propose new features [here](https://github.com/VictoriaMetrics/V Below is the output for `/path/to/vminsert -help`: -``` +```shellhelp -blockcache.missesBeforeCaching int The number of cache misses before putting the block into cache. Higher values may reduce indexdb/dataBlocks cache size at the cost of higher CPU and disk read usage (default 2) -cacheExpireDuration duration diff --git a/docs/README.md b/docs/README.md index cf3561fa4..f6f327c20 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2790,7 +2790,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 +```shellhelp -bigMergeConcurrency int Deprecated: this flag does nothing -blockcache.missesBeforeCaching int diff --git a/docs/vmagent.md b/docs/vmagent.md index 15334a0ae..45a693a3e 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -1662,7 +1662,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 +```shellhelp ./vmagent -help vmagent collects metrics data via popular data ingestion protocols and routes them to VictoriaMetrics. diff --git a/docs/vmalert.md b/docs/vmalert.md index 61a2e6ae3..107ff7f88 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -1029,7 +1029,7 @@ command-line flags with their descriptions. The shortlist of configuration flags is the following: -```sh +```shellhelp -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 diff --git a/docs/vmauth.md b/docs/vmauth.md index 5a798c229..f9e2c5614 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -1170,7 +1170,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 +```shellhelp ./vmauth -help vmauth authenticates and authorizes incoming requests and proxies them to VictoriaMetrics. diff --git a/docs/vmbackup.md b/docs/vmbackup.md index 365b02e7e..e58e200d3 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -325,7 +325,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 +```shellhelp -concurrency int The number of concurrent workers. Higher concurrency may reduce backup duration (default 10) -configFilePath string diff --git a/docs/vmgateway.md b/docs/vmgateway.md index ec9858085..88012b4d0 100644 --- a/docs/vmgateway.md +++ b/docs/vmgateway.md @@ -270,7 +270,7 @@ Example usage for tokens issued by Google: Below is the list of configuration flags (it can be viewed by running `./vmgateway -help`): -```sh +```shellhelp -auth.httpHeader string HTTP header name to look for JWT authorization token (default "Authorization") -auth.jwksEndpoints array diff --git a/docs/vmrestore.md b/docs/vmrestore.md index afb57d05a..f0ce35067 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -19,7 +19,7 @@ VictoriaMetrics must be stopped during the restore process. Run the following command to restore backup from the given `-src` into the given `-storageDataPath`: -```sh +```shellhelp ./vmrestore -src=:// -storageDataPath= ```