From cad2cb2b56b1d624c7e7265b85cc57bf8eb009a4 Mon Sep 17 00:00:00 2001
From: Denys Holius <5650611+denisgolius@users.noreply.github.com>
Date: Mon, 22 Apr 2024 15:53:26 +0300
Subject: [PATCH] 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.
(cherry picked from commit 9bedbcfa2f2a97875ec3425c0d73dd2002e27304)
---
docs/README.md | 2 +-
docs/Single-server-VictoriaMetrics.md | 2 +-
docs/vmagent.md | 2 +-
docs/vmalert.md | 2 +-
docs/vmauth.md | 2 +-
docs/vmbackup.md | 2 +-
docs/vmbackupmanager.md | 2 +-
docs/vmgateway.md | 2 +-
docs/vmrestore.md | 2 +-
9 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 486003f451..dcd35ae519 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -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
diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md
index c98f0420b1..e3329834db 100644
--- a/docs/Single-server-VictoriaMetrics.md
+++ b/docs/Single-server-VictoriaMetrics.md
@@ -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
diff --git a/docs/vmagent.md b/docs/vmagent.md
index 227c6e45d0..752efb903d 100644
--- a/docs/vmagent.md
+++ b/docs/vmagent.md
@@ -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.
diff --git a/docs/vmalert.md b/docs/vmalert.md
index 1534ee835e..a5c03c3f35 100644
--- a/docs/vmalert.md
+++ b/docs/vmalert.md
@@ -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
diff --git a/docs/vmauth.md b/docs/vmauth.md
index 56d5367cc8..b69dd8d485 100644
--- a/docs/vmauth.md
+++ b/docs/vmauth.md
@@ -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.
diff --git a/docs/vmbackup.md b/docs/vmbackup.md
index 628e364bf0..465e2f8a5e 100644
--- a/docs/vmbackup.md
+++ b/docs/vmbackup.md
@@ -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
diff --git a/docs/vmbackupmanager.md b/docs/vmbackupmanager.md
index 2bcd7dbdb6..dcef2ab9c5 100644
--- a/docs/vmbackupmanager.md
+++ b/docs/vmbackupmanager.md
@@ -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:
diff --git a/docs/vmgateway.md b/docs/vmgateway.md
index 09445aee8b..cc263e66a8 100644
--- a/docs/vmgateway.md
+++ b/docs/vmgateway.md
@@ -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
diff --git a/docs/vmrestore.md b/docs/vmrestore.md
index a8dec2ce13..f640539a92 100644
--- a/docs/vmrestore.md
+++ b/docs/vmrestore.md
@@ -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