Aliaksandr Valialkin
813a7aec6c
docs: return back spellcheck fixes from the commit 92b22581e6, which were accidentally reverted in 45cf83cd8f
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6470
2024-06-25 02:33:59 +02:00
Aliaksandr Valialkin
7f2b491748
Revert "docs: Add spellcheck workflow ( #6470 )"
...
This reverts commit 92b22581e6
2024-06-25 02:28:38 +02:00
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
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
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
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
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
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
Fred Navruzov
c9d8627676
- v1.11 doc updates ( #5852 )
...
- fix dead links
2024-02-23 01:11:05 +02: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
Fred Navruzov
790ee9af6d
update guide and changelog to 1.9.1 ( #5706 )
2024-01-29 17:23:06 +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
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
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
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
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
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
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
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
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
