Arkadii Yakovets
c454084eb1
docs: Add spellcheck workflow ( #6470 )
...
### Describe Your Changes
This is a follow-up PR containing workflow related part of the initial
[PR#6362](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6362 ).
It adds spell checking control based on
[cspell](https://github.com/streetsidesoftware/cspell ). The related
configs are consolidated under `cspell` directory.
You can add VictoriaMetrics specific terms into `cspell/custom-dict.txt`
(it contains ~30 items atm). All other absent commonly used terms should
be added directly to respective
[cspell-dicts](https://github.com/streetsidesoftware/cspell-dicts/blob/main/CONTRIBUTING.md ).
### Checklist
The following checks are **mandatory**:
- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
---------
Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com>
(cherry picked from commit 92b22581e6
2024-06-24 12:50:13 +02:00
Fred Navruzov
73fbce30bd
docs/vmanomaly - add config example for min_dev arg ( #6490 )
...
### Describe Your Changes
Added config example for `min_dev_from_expected` arg; also, small
styling fixes and alignments
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-06-17 12:11:50 +02:00
Fred Navruzov
455d761de9
docs/vmanomaly: fix-typos-in-v1.13-preset ( #6484 )
...
### Describe Your Changes
small fix of typos in v1.13 presets (vmanomaly docs)
### Checklist
The following checks are **mandatory**:
- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
(cherry picked from commit 1cf28598c6
2024-06-14 13:26:44 +02:00
Fred Navruzov
aa85b772bb
docs/vmanomaly: update preset guide and cross-links ( #6480 )
...
### Describe Your Changes
Updates and cross-references for `preset` mode of `vmanomaly` [in
docs](https://docs.victoriametrics.com/anomaly-detection/presets/ )
### Checklist
The following checks are **mandatory**:
- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
(cherry picked from commit 2184c0c730
2024-06-14 13:26:37 +02:00
Daria Karavaieva
ae39b02496
docs/vmanomaly: preset guide ( #6151 )
...
- added instructions of how to run presets
- description of Node Exporter indicators covered
(cherry picked from commit c32b8d39dd
2024-06-14 13:26:29 +02:00
Fred Navruzov
ea90d91a30
docs/vmanomaly - fix 404 img links & remove outdated models ( #6460 )
...
### Describe Your Changes
Fix 404 relative img links for v1.13.0 update of vmanomaly docs
### Checklist
The following checks are **mandatory**:
- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
(cherry picked from commit 9a355c3512
2024-06-11 17:05:10 +02:00
Fred Navruzov
0219d34b21
docs/vmanomaly - release 1.13.0 preparation ( #6436 )
...
### Describe Your Changes
[vmanomaly docs](https://docs.victoriametrics.com/anomaly-detection/ )
update for changes, introduced in v1.13.0
### Checklist
The following checks are **mandatory**:
- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
(cherry picked from commit 1feb5d04d7
2024-06-11 17:05:07 +02:00
Arkadii Yakovets
a6655322b1
docs: fix docs/ and README.md spelling errors ( #6362 )
...
Fixes `docs/` and `README.md` typos and errors.
Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com>
(cherry picked from commit c740a8042e
2024-06-03 11:53:33 +02:00
Fred Navruzov
b200c4263a
docs/vmanomaly: improve FAQ ( #6369 )
...
### Describe Your Change
More explicit [vmanomaly
FAQ](https://docs.victoriametrics.com/anomaly-detection/faq/index.html ),
based on common Q&A from recent communications with users
### Checklist
The following checks are **mandatory**:
- ✔️ My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-05-30 16:16:56 +02:00
Daria Karavaieva
aea042bc9d
docs/vmanomaly: backtest parameter fix ( #6327 )
...
### Fix backtest parameters
Fix date parameters names in vmanomaly backtest scheduler component
documentation.
(cherry picked from commit c40f355496
2024-05-22 16:40:01 +02:00
Aliaksandr Valialkin
b933001d2d
all: replace old https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html url with the new one - https://docs.victoriametrics.com/single-server-victoriametrics/
2024-04-18 03:11:49 +02:00
Aliaksandr Valialkin
a21d1fcf57
all: replace old https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html url with the new one - https://docs.victoriametrics.com/cluster-victoriametrics/
2024-04-18 02:56:28 +02:00
Aliaksandr Valialkin
baf5c8d6d0
all: replace old https://docs.victoriametrics.com/keyConcepts.html url with the new one - https://docs.victoriametrics.com/keyconcepts/
2024-04-18 02:34:09 +02:00
Aliaksandr Valialkin
64938732e3
all: replace old https://docs.victoriametrics.com/MetricsQL.html url with the new one - https://docs.victoriametrics.com/metricsql/
2024-04-18 02:15:33 +02:00
Aliaksandr Valialkin
a99005eff6
all: replace old https://docs.victoriametrics.com/vmalert.html url with the new one - https://docs.victoriametrics.com/vmalert/
2024-04-18 01:44:54 +02:00
Aliaksandr Valialkin
0211a04a52
all: replace the outdated url https://docs.victoriametrics.com/vmagent.html with the new one - https://docs.victoriametrics.com/vmagent/
2024-04-18 01:32:57 +02:00
Hui Wang
9c0da1ef3d
deployment: bump victoriametrics components to v1.100.1 ( #6096 )
2024-04-12 12:19:21 +02:00
Aliaksandr Valialkin
fe28388c5d
deployment: update VictoriaMetrics docer image from v1.99.0 to v1.100.0
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.100.0
2024-04-04 15:29:12 +03:00
Aliaksandr Valialkin
18e521dbff
docs: change old url from https://docs.victoriametrics.com/enterprise.html to new url https://docs.victoriametrics.com/enterprise/
2024-04-04 15:22:38 +03:00
Fred Navruzov
28f7b2218a
docs/vmanomaly: typos fix ( #6047 )
2024-04-03 02:45:35 +03:00
Fred Navruzov
d83e05a3e9
docs/vmanomaly: v1.12 updates & fixes ( #6046 )
...
* docs/vmanomaly: v1.12.0 & link updates
* add autotuned description to model section
* - update refs of vmanomaly on enterprise and vmalert pages
- add diagrams for model types
- update self-monitoring section
* - fix typos
- remove .index.html from links
2024-04-03 02:44:58 +03:00
Daria Karavaieva
dbdbbacf93
docs/vmanomaly: fix 404 links ( #5968 )
2024-03-17 23:16:15 +02:00
Daria Karavaieva
98b56476d7
redirect alias ( #5934 )
2024-03-06 13:54:48 +02:00
Aliaksandr Valialkin
5f0dd8743c
docs: bump the latest VictoriaMetrics release from v1.98.0 to v1.99.0
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.99.0
2024-03-01 04:24:11 +02:00
Aliaksandr Valialkin
38b42489c6
docs/anomaly-detection/guides: bump alertmanager version from v0.25.0 to v0.27.0 after 3723c809a1
2024-02-29 14:51:39 +02:00
Fred Navruzov
c9d8627676
- v1.11 doc updates ( #5852 )
...
- fix dead links
2024-02-23 01:11:05 +02:00
Daria Karavaieva
550b589790
Vmanomaly Quickstart Fix absolute links ( #5831 )
...
* links fix
* typo fix
(cherry picked from commit 4034d081f4
2024-02-20 16:27:52 +01:00
Daria Karavaieva
a68518c0e0
Vmanomaly QuickStart ( #5800 )
...
* first edit
* typo 1
* typo 2
* fixes 3
* fixes 4
* fixes 5
* fixes, cross links
* v1.10 config
* models why, self-monitoring fix
* config next steps
* fixes
* minor fix
(cherry picked from commit b2baf7d472
2024-02-20 16:27:52 +01:00
Fred Navruzov
d8de87aeb0
docs: vmanomaly - updates of v1.10.0 and model type section ( #5813 )
...
* - apply v1.10 changes
- chapter on model types (uni/multivariate and rolling)
* - update self-monitoring labels description
- fix typos
* fix duplicated text and link rendering
(cherry picked from commit 172e196ac9
2024-02-16 15:31:56 +01:00
Aliaksandr Valialkin
77a514f2cc
all: update Docker image tag for VictoriaMetrics components from v1.97.1 to v1.98.0
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.98.0
2024-02-14 17:14:55 +02:00
Daria Karavaieva
0ff3e6f3bc
Vmanomaly Guide - dashboard and query change ( #5771 )
...
* dashboard fix
* query fix
* changed screenshots
* minor fixes
2024-02-07 01:31:15 +02:00
Fred Navruzov
eaf75a565f
update changelog with 1.0.0 helm chart ref ( #5763 )
2024-02-06 15:58:49 +02:00
Fred Navruzov
be41ffb925
docs: vmanomaly - fix 1.9.2 references in pull cmd and docs ( #5756 )
...
* fix 1.9.2 references in pull cmd and docs
* better readability of upgrade note
2024-02-05 11:43:41 +02:00
Aliaksandr Valialkin
24437b6d70
all: update VictoriaMetrics Docker image from v1.97.0 to v1.97.1
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.97.1
2024-02-01 16:15:14 +02:00
Aliaksandr Valialkin
f1effc1133
all: update VictoriaMetrics Docker image from v1.96.0 to v1.97.0
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.97.0
2024-01-30 23:37:42 +02:00
Fred Navruzov
ff67f4d3fb
- fix link/version of helm chart in update request ( #5716 )
2024-01-29 18:22:11 +01:00
Fred Navruzov
8043cf35d8
- update versions to 1.9.2 ( #5714 )
...
- update guide asset urls to flat
2024-01-29 18:20:38 +01:00
Fred Navruzov
790ee9af6d
update guide and changelog to 1.9.1 ( #5706 )
2024-01-29 17:23:06 +01:00
hagen1778
216f268c1a
docs: follow-up after 491287ed15
...
* port un-synced changed from docs/readme to readme
* consistently use `sh` instead of `console` highlight, as it looks like
a more appropriate syntax highlight
* consistently use `sh` instead of `bash`, as it is shorter
* consistently use `yaml` instead of `yml`
See syntax codes here https://gohugo.io/content-management/syntax-highlighting/
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-01-29 17:06:26 +01:00
hagen1778
3baeface89
docs: follow-up after 491287ed15
...
491287ed15
2024-01-29 16:59:13 +01:00
Artem Navoiev
0d210308c3
docs: remove witdh from images, remove <p>, remove <div> ( #5705 )
...
* docs: remove witdh from images, remove <p>, remove <div>
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* docs: remove <div> clarify language in code blocks
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
---------
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-29 16:50:51 +01:00
Daria Karavaieva
469bbbb2fa
version 1.9.1 update, dashboard viz flag ( #5704 )
2024-01-29 16:48:55 +01:00
Artem Navoiev
d42908133c
docs: remove <p> for imanges ( #5702 )
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-26 22:34:40 +01:00
Artem Navoiev
6ed9a05a08
docs: vmanomaly fix images
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-26 21:08:28 +01:00
Daria Karavaieva
b042982339
Vmanomaly Guide dashboard provisioning ( #5679 )
...
* dashboard provisioning
* delete dashboard filter, new query
* dashboard screens, guide fixes
2024-01-26 21:07:44 +01:00
Fred Navruzov
7b1325c3a3
- fix 404 errors after page remaning ( #5664 )
...
- slight text fixes
2024-01-23 12:59:01 +02:00
Daria Karavaieva
7ad16c8f17
add 1.8.0 notes to changelog ( #5616 )
...
* add 1.8.0 notes to changelog
* added release date
* MAD internal link
* monitoring health deprecation
2024-01-23 02:31:21 +02:00
Artem Navoiev
fbbd5ab1e7
docs vmanomaly fix anchor
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 01:36:22 +02:00
Fred Navruzov
b76c489e57
- fix 404 links after renaming ( #5653 )
...
- improve wording on diagram
- swap enterprise/about chapters for page clarity
2024-01-22 01:14:54 +02:00
Fred Navruzov
11c5b5d3ab
docs: vmanomaly - add component interaction diagram ( #5652 )
...
* add interaction diagram for vmanomaly components
* small docs fixes
* resolve suggestions
2024-01-22 01:14:16 +02:00
Artem Navoiev
1e14c3177b
vmanomly use proper title for overiview doc
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:52:56 +02:00
Artem Navoiev
75920ab3b1
docs add docs titles
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:28:54 +02:00
Artem Navoiev
c8fc813e00
vmanonamly docs fix sorting for jekill as far it doesnt support of sorting the folders
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:28:17 +02:00
Artem Navoiev
f3b4ca6a77
vmanomaly remove unused pages from menu
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:27:49 +02:00
Artem Navoiev
7eff777467
vmanomly specify the right menu parent for overview page
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:27:26 +02:00
Artem Navoiev
0ec4134ab6
docs vmanmoly fix sorting
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:26:59 +02:00
Artem Navoiev
b5363ffab2
Move vmanomaly page to its own section ( #5646 )
...
* docs: move vmanomaly overview page to its section
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* add alias for backward compatibility
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* fix links
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* change title
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
---------
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:26:37 +02:00
Fred Navruzov
3b8f4714c3
docs: vmanomaly slight improvements ( #5637 )
...
* - better messaging
- update links to dockerhub in guides
- added anomaly_score to FAQ
- improve model section (sort + use cases)
- slight refactor of a guide
* rename guide & change refs
* change wording in installation options
* - update remaining text reference
- add cross-link to component sections in guide
* add docs/.jekyll-metadata to .gitignore
2024-01-22 00:24:39 +02:00
Artem Navoiev
79b308fa54
docs: vmanomaly update vmanomaly + vmalert guide ( #5636 )
...
* docs: vmanomaly update vmanomaly + vmalert guide
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* docs: vmanomaly update vmanomaly + vmalert guide. Update docker compose and monitoring section
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* typos and fixes
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
---------
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:19:15 +02:00
Artem Navoiev
b1fe59df8b
vmanomaly docs fix broken relative links
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-21 23:53:39 +02:00
Artem Navoiev
547b62a807
docs/anomaly-detection/components/models.md add sort:1
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-21 23:53:10 +02:00
Artem Navoiev
7c62010d04
vmanonaly docs add .html for the section document models
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-21 23:52:41 +02:00
Artem Navoiev
b66b059231
vmanomaly docs simplify the strcuture ( #5634 )
...
* vmanomaly docs simplify the strcuture
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* fix links
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
---------
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-21 23:52:07 +02:00
Artem Navoiev
bdf4f0f1e2
docs: vmanomaly fix font matter
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-17 00:12:05 +02:00
Artem Navoiev
a1ae06cc04
docs: vmanomaly remove commented text
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-17 00:07:36 +02:00
Artem Navoiev
55a03ff454
docs: vmanomaly fix image size
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 21:56:25 +02:00
Artem Navoiev
83287bde1c
vmanomly: guide add diagramm
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 21:55:59 +02:00
Artem Navoiev
f3364bbd8b
docs: vmanomaly fix formatting and remove unnecessary elements
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 21:55:42 +02:00
Artem Navoiev
6370ae2d88
vmanomaly - models a bit pretify docs ( #5618 )
...
* vmanomaly - models a bit pretify docs
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* typi
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* fix formatting
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
---------
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 21:54:33 +02:00
Artem Navoiev
a90c9bf8c9
vmanomaly guides - fix formating, add missing piece, clarify statement, use common languagefor VM ecosystem ( #5620 )
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 21:53:59 +02:00
Artem Navoiev
44ff8b3647
clarify cluster multitenacy in vmanomaly docs ( #5619 )
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 21:53:30 +02:00
Fred Navruzov
2b372de326
docs: vmanomaly chapter hotfixes ( #5583 )
...
* update link to book a demo for AD & RCA
* fix invalid refs in components/model
* - fix staging -> prod links
- replace capitalized FAQ headers
- change the section order on main page
- replace :latest tag with current stable
2024-01-16 19:53:25 +02:00
Fred Navruzov
99c545bff8
- fix 404 in /guides page ( #5582 )
...
- change back AD section title
2024-01-16 19:50:01 +02:00
Denys Holius
74c99549d6
docs/anomaly-detection/guides/README.md: fixed markdown link to the vmanomaly guide ( #5578 )
2024-01-16 19:12:50 +02:00
Artem Navoiev
54723fc94e
docs: vmanomaly add list of guides to guides page
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 19:12:04 +02:00
Artem Navoiev
77570d83ee
docs: change sorting of anomaly deteciton
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 19:10:56 +02:00
Fred Navruzov
2b404742e2
docs: vmanomaly part 1 ( #5558 )
...
* add `AD` section, fix links, release docs and changelog
* - connect sections, refactor structure
* - resolve suggestions
- add FAQ section
- fix dead links
* - fix incorrect render of tables for Writer
- comment out internal readers/writers
- fix page ordering to some extent
* - link licensing requirements from v1.5.0 to main page
---------
Co-authored-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 19:09:37 +02:00
