Arkadii Yakovets
92b22581e6
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>
2024-06-21 11:56:20 -07:00
Fred Navruzov
06cb33dede
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-14 18:40:20 +03:00
Fred Navruzov
1cf28598c6
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/ ).
2024-06-14 12:52:54 +03:00
Fred Navruzov
2184c0c730
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/ ).
2024-06-14 09:39:55 +02:00
Daria Karavaieva
c32b8d39dd
docs/vmanomaly: preset guide ( #6151 )
...
- added instructions of how to run presets
- description of Node Exporter indicators covered
2024-06-13 22:11:54 +03:00
Fred Navruzov
9a355c3512
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/ ).
2024-06-11 16:29:11 +03:00
Fred Navruzov
1feb5d04d7
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/ ).
2024-06-11 13:15:05 +03:00
Arkadii Yakovets
c740a8042e
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>
2024-06-03 10:04:13 +02:00
Fred Navruzov
0a71bad722
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-29 20:46:52 +03:00
Daria Karavaieva
c40f355496
docs/vmanomaly: backtest parameter fix ( #6327 )
...
### Fix backtest parameters
Fix date parameters names in vmanomaly backtest scheduler component
documentation.
2024-05-22 12:02:02 +02:00
Aliaksandr Valialkin
e9642e99f2
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:03 +02:00
Aliaksandr Valialkin
f4b1cbfef0
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:54:20 +02:00
Aliaksandr Valialkin
e128ef7ace
all: replace old https://docs.victoriametrics.com/keyConcepts.html url with the new one - https://docs.victoriametrics.com/keyconcepts/
2024-04-18 02:33:29 +02:00
Aliaksandr Valialkin
8eeb045d3f
all: replace old https://docs.victoriametrics.com/MetricsQL.html url with the new one - https://docs.victoriametrics.com/metricsql/
2024-04-18 02:14:53 +02:00
Aliaksandr Valialkin
b4fac26360
all: replace old https://docs.victoriametrics.com/vmalert.html url with the new one - https://docs.victoriametrics.com/vmalert/
2024-04-18 01:44:12 +02:00
Aliaksandr Valialkin
c81a633b02
all: replace the outdated url https://docs.victoriametrics.com/vmagent.html with the new one - https://docs.victoriametrics.com/vmagent/
2024-04-18 01:31:37 +02:00
Hui Wang
2123821e0f
bump victoriametrics components to v1.100.1 ( #6095 )
...
* bump victoriametrics components to v1.100.1
* add one
2024-04-12 18:16:17 +08:00
Aliaksandr Valialkin
8cd6f7ea3c
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:00 +03:00
Aliaksandr Valialkin
00e5e00a5a
docs: change old url from https://docs.victoriametrics.com/enterprise.html to new url https://docs.victoriametrics.com/enterprise/
2024-04-04 15:21:59 +03:00
Fred Navruzov
daa1326b98
docs/vmanomaly: typos fix ( #6047 )
2024-04-01 13:23:44 -07:00
Fred Navruzov
c300ce659f
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-01 16:41:55 +03:00
Daria Karavaieva
75aa704ee6
docs/vmanomaly: fix 404 links ( #5968 )
2024-03-13 21:04:00 +01:00
Daria Karavaieva
e036433b8b
redirect alias ( #5934 )
2024-03-06 11:28:31 +01:00
Aliaksandr Valialkin
44b721f201
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:23:49 +02:00
Aliaksandr Valialkin
c6221c9046
docs/anomaly-detection/guides: bump alertmanager version from v0.25.0 to v0.27.0 after 3723c809a1
2024-02-29 14:51:28 +02:00
Fred Navruzov
34aa25d681
- v1.11 doc updates ( #5852 )
...
- fix dead links
2024-02-22 18:48:54 +01:00
Daria Karavaieva
4034d081f4
Vmanomaly Quickstart Fix absolute links ( #5831 )
...
* links fix
* typo fix
2024-02-20 16:19:18 +01:00
Daria Karavaieva
b2baf7d472
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
2024-02-20 15:20:57 +01:00
Fred Navruzov
172e196ac9
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
2024-02-16 11:02:41 +02:00
Aliaksandr Valialkin
08e6100050
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:41 +02:00
Daria Karavaieva
4a31bd9661
Vmanomaly Guide - dashboard and query change ( #5771 )
...
* dashboard fix
* query fix
* changed screenshots
* minor fixes
2024-02-06 22:40:40 +01:00
Fred Navruzov
f0e51dd01d
update changelog with 1.0.0 helm chart ref ( #5763 )
2024-02-05 20:43:40 +02:00
Fred Navruzov
3ac49e5c38
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-02 19:06:07 +02:00
Aliaksandr Valialkin
507744ebb4
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:01 +02:00
Aliaksandr Valialkin
9ce75ee11b
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:28 +02:00
Fred Navruzov
b2434ec340
- fix link/version of helm chart in update request ( #5716 )
2024-01-29 18:55:07 +02:00
Fred Navruzov
b4aef0c141
- update versions to 1.9.2 ( #5714 )
...
- update guide asset urls to flat
2024-01-29 15:47:27 +02:00
Fred Navruzov
9b555a0034
update guide and changelog to 1.9.1 ( #5706 )
2024-01-28 09:43:28 +02:00
hagen1778
6c6c2c185f
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-27 19:29:11 +01:00
hagen1778
c20d68e28d
docs: follow-up after 491287ed15
...
491287ed15
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-01-27 19:11:38 +01:00
Artem Navoiev
491287ed15
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-27 10:08:07 -08:00
Daria Karavaieva
4a9f8f4cb0
version 1.9.1 update, dashboard viz flag ( #5704 )
2024-01-27 14:16:02 +01:00
Artem Navoiev
97937d58c4
docs: remove <p> for imanges ( #5702 )
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-26 13:06:48 -08:00
Artem Navoiev
bc033a2b30
docs: vmanomaly fix images
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-26 17:59:37 +01:00
Daria Karavaieva
105cb44884
Vmanomaly Guide dashboard provisioning ( #5679 )
...
* dashboard provisioning
* delete dashboard filter, new query
* dashboard screens, guide fixes
2024-01-26 17:12:58 +01:00
Fred Navruzov
2adb38a9c4
- fix 404 errors after page remaning ( #5664 )
...
- slight text fixes
2024-01-23 01:56:42 -08:00
Daria Karavaieva
ffaf48b99e
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-22 23:51:12 +01:00
Artem Navoiev
3f7ed7e6b2
docs vmanomaly fix anchor
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-21 22:21:37 +01:00
Fred Navruzov
7e68722686
- fix 404 links after renaming ( #5653 )
...
- improve wording on diagram
- swap enterprise/about chapters for page clarity
2024-01-21 21:24:29 +02:00
Fred Navruzov
0038102b98
docs: vmanomaly - add component interaction diagram ( #5652 )
...
* add interaction diagram for vmanomaly components
* small docs fixes
* resolve suggestions
2024-01-21 19:33:59 +02:00
Artem Navoiev
873483a782
vmanomly use proper title for overiview doc
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-19 19:59:17 +01:00
Artem Navoiev
6a2a8cd426
docs add docs titles
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-19 17:02:20 +01:00
Artem Navoiev
dfa43da1a2
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-19 16:55:44 +01:00
Artem Navoiev
1af5faa4af
vmanomaly remove unused pages from menu
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-19 16:50:12 +01:00
Artem Navoiev
5e17636994
vmanomly specify the right menu parent for overview page
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-19 16:43:18 +01:00
Artem Navoiev
c425ec3088
docs vmanmoly fix sorting
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-19 16:15:40 +01:00
Artem Navoiev
ec85d32e21
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-19 07:00:41 -08:00
Fred Navruzov
69ae1d30bf
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-18 02:37:36 -08:00
Artem Navoiev
f89d16fc4c
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-17 11:49:51 -08:00
Artem Navoiev
a3b3ea4d73
vmanomaly docs fix broken relative links
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-17 15:41:03 +01:00
Artem Navoiev
9a353ee695
docs/anomaly-detection/components/models.md add sort:1
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-17 15:26:38 +01:00
Artem Navoiev
0c06934a59
vmanonaly docs add .html for the section document models
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-17 15:25:30 +01:00
Artem Navoiev
5b419cfb2b
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-17 06:20:27 -08:00
Artem Navoiev
846d5a3ab8
docs: vmanomaly fix font matter
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 16:58:48 +01:00
Artem Navoiev
481471b872
docs: vmanomaly remove commented text
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-16 16:43:59 +01:00
Artem Navoiev
51cdf3676b
docs: vmanomaly fix image size
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-15 23:10:52 +01:00
Artem Navoiev
74219a1727
vmanomly: guide add diagramm
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-15 23:07:49 +01:00
Artem Navoiev
041a1966c5
docs: vmanomaly fix formatting and remove unnecessary elements
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-15 22:45:02 +01:00
Artem Navoiev
191e322879
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-15 13:26:38 -08:00
Artem Navoiev
544da241e8
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-15 13:26:26 -08:00
Artem Navoiev
0c78b891b0
clarify cluster multitenacy in vmanomaly docs ( #5619 )
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-15 12:36:28 -08:00
Fred Navruzov
e34f77aed4
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-09 11:04:24 +01:00
Fred Navruzov
bbea02f82b
- fix 404 in /guides page ( #5582 )
...
- change back AD section title
2024-01-08 11:27:16 -08:00
Denys Holius
eb08f5c7e5
docs/anomaly-detection/guides/README.md: fixed markdown link to the vmanomaly guide ( #5578 )
2024-01-08 02:41:52 -08:00
Artem Navoiev
1aa39efec1
docs: vmanomaly add list of guides to guides page
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-08 10:44:48 +01:00
Artem Navoiev
07e5d6f0fb
docs: change sorting of anomaly deteciton
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-08 10:39:38 +01:00
Fred Navruzov
f75874f5df
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-08 01:31:36 -08:00