Roman Khavronenko
7644efae01
Docs update ( #1199 )
...
* docs: drop table of contents for `vmctl`
We already have it autogenerated on .github.io, so no need to keep it.
* docs: mention OpenTSDB migration feature for vmctl
* docs: sync docs for `vmalert`
2021-04-10 15:46:08 +03:00
Roman Khavronenko
c6a8ebb11f
docs: update docs ordering and formatting ( #1192 )
...
The major change is adding `sort` directive to docs. For those docs which are copied
from internal packages `sort` is added via makefile command. For the rest it is added
manually since they're updated manually as well.
The rest of changes is connected with markdown formatting. For example, changing headers
in some files (`##` => `#`) makes navigation on .github.io to look better. This especially
useful for `changelog` docs.
Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io.
No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 13:39:16 +03:00
Aliaksandr Valialkin
1db1a29ffa
all: increase minimum supported Go version for building VictoriaMetrics components from v1.14 to v1.15
...
This is needed after the commit c0ac740f93https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1147
2021-03-29 23:04:53 +03:00
Aliaksandr Valialkin
f6529f932a
docs: add a link to the repository from build instruction for all the VictoriaMetrics components
2021-03-25 17:14:42 +02:00
Aliaksandr Valialkin
c3c3e51f17
docs/vmalert.md: remove misleading -evaluationInterval=3s from example config args
...
3s evaluation interval is too small for practical setups. It can result in increased load on datasource.
So it is better to remove it from example config args, which are usually copy-pasted by novice users.
2021-03-25 15:29:06 +02:00
Aliaksandr Valialkin
85a95bf60c
all: various fixes in command-line flag descriptions
2021-03-15 21:59:25 +02:00
Ihor Borodin
d212f35ae8
Fixing examples of external.alert.source in documentation ( #1120 )
...
* Fixing examples of external.alert.source in documentation
2021-03-09 20:49:50 +00:00
Aliaksandr Valialkin
201b685b13
all: bump minimum supported Go version from 1.13 to 1.14
2021-03-03 15:57:13 +02:00
Alexandros Orfanos
f4f8f21875
vmalert: docs update - status endpoint needs group ID, not group name ( #1106 )
2021-03-03 07:46:10 +00:00
Aliaksandr Valialkin
baefe5a8ad
docs: actualize -help output
2021-03-01 17:01:27 +02:00
Roman Khavronenko
2ff038d841
vmalert: mention -datasource.appendTypePrefix in README ( #1052 )
2021-02-03 23:44:37 +02:00
Aliaksandr Valialkin
a2344ef4b7
docs/vmalert.md: mention that type option can be set at group level additionally to rule level
2021-02-03 21:13:13 +02:00
Aliaksandr Valialkin
5d87dbfd65
docs: document ability to query Graphite datasource from vmalert
2021-02-01 15:26:33 +02:00
Nikolay
1de15ad490
adds escape for CRLF ( #984 )
...
at external.alert.source - \n and \r symbols was url encoded, instead of direct usage.
replace it from "\n" to `\n` allows to skip url encoding.
https://github.com/VictoriaMetrics/VictoriaMetrics/issues/890
2020-12-25 11:03:13 +02:00
Aliaksandr Valialkin
0326638c90
app/vmalert: typo fix in descriptions for notifier.basicAuth.username and notifier.basicAuth.password command-line flags
2020-12-24 12:48:59 +02:00
Aliaksandr Valialkin
9df60518bb
docs: mention that it is possible to set multiple -notifier.tlsInsecureSkipVerify command-line flags for vmalert
...
See c3a92968343c2b3619f1ab935702d0e9b3a46733
2020-12-22 22:32:13 +02:00
Aliaksandr Valialkin
1eabbc0e27
docs/vmagent.md: mention that sample_limit option has no sense when stream parsing is enabled
2020-12-15 18:43:41 +02:00
Aliaksandr Valialkin
9d42546a27
docs: consistently use links to https://victoriametrics.github.io for documentation references
2020-12-11 21:08:18 +02:00
Aliaksandr Valialkin
590d8d537f
docs/vmalert.md: make docs-sync
2020-10-13 18:34:32 +03:00
Aliaksandr Valialkin
d25dd7fdb6
docs: make docs-sync
2020-09-30 09:50:29 +03:00
Aliaksandr Valialkin
f6f5c4118c
docs: make docs-sync
2020-09-21 21:47:47 +03:00
Aliaksandr Valialkin
d7c04db1fc
docs: sync docs for vmalert, vmauth, vmbackup and vmrestore
2020-09-09 21:10:34 +03:00
Aliaksandr Valialkin
de6970e828
docs/vmalert.md: sync with app/vmalert/README.md via make docs-update
2020-08-28 09:51:48 +03:00
Aliaksandr Valialkin
184670fb9b
docs: update docs
2020-08-14 19:13:42 +03:00
Aliaksandr Valialkin
3f498cf2dc
docs/{vmagent,vmalert}: add instruction on how to build for ARM
2020-07-31 09:25:22 +03:00
Aliaksandr Valialkin
e255c066cc
docs/vmalert.md: sync with app/vmalert/README.md
2020-07-30 21:56:48 +03:00
Aliaksandr Valialkin
63e5ee0d29
docs: sync with upstream
2020-06-29 22:09:03 +03:00
Aliaksandr Valialkin
e65b4cb6b1
docs/vmalert.md: sync with app/vmalert/README.md
2020-06-23 22:49:38 +03:00
Aliaksandr Valialkin
818abca8f1
make docs-sync
2020-06-18 23:55:28 +03:00
Aliaksandr Valialkin
e53ee763f9
docs/vmalert.md: sync with app/vmalert/README.md
2020-06-10 19:38:24 +03:00
Aliaksandr Valialkin
f7ff809c1e
docs/vmalert.md: sync with app/vmalert/README.md via make docs-sync
2020-06-02 19:15:15 +03:00
Aliaksandr Valialkin
ab8f5545bc
docs/vmalert.md: sync with app/vmalert/README.md
2020-05-15 13:27:09 +03:00
Aliaksandr Valialkin
21598ac417
docs/vmalert.md: sync with app/vmalert/README.md
2020-05-13 22:55:35 +03:00
Aliaksandr Valialkin
1aea001532
docs/vmalert.md: sync with app/vmalert/README.md
2020-05-05 07:50:57 +03:00
Aliaksandr Valialkin
d0ebbb166e
docs: add vmalert.md
2020-04-29 17:42:06 +03:00
