Aliaksandr Valialkin
6aad1d43e9
docs/anomaly-detection/components/models.md: remove {width="800px"} in the same was as it was done in 4735d8803e
2024-07-25 13:39:47 +02:00
Artem Navoiev
147e703d64
docs: anomaly detection remove html tags
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-07-24 20:12:19 +02:00
Artem Navoiev
4735d8803e
docs: remove img width
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-07-24 20:09:03 +02:00
Artem Navoiev
ef0e6af6a8
docs: vmanomaly use absolute links in code comments
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-07-24 19:58:16 +02:00
Andrii Chubatiuk
ce4cc4cbb2
view documentation locally ( #6677 )
...
### Describe Your Changes
- moved files from root to VictoriaMetrics folder to be able to mount
operator docs and VictoriaMetrics docs independently
- added ability to run website locally
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-07-24 01:00:31 -07:00
Andrii Chubatiuk
332b7788fb
added _index.md for hugo, which point to README.md ( #6686 )
...
### Describe Your Changes
Please provide a brief description of the changes you made. Be as
specific as possible to help others understand the purpose and impact of
your modifications.
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-07-23 17:30:49 +03:00
Fred Navruzov
2fa03306c3
docs/vmanomaly - v1.13.2 updates ( #6646 )
...
### Describe Your Changes
Doc updates after v1.13.2 release of `vmanomaly`
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-07-15 17:05:33 +03:00
Daria Karavaieva
7478d2de4c
docs/vmanomaly:custom model guide fix ( #6594 )
...
### Describe Your Changes
Fixed Custom Model guide according to newer `vmanomaly` versions
### Checklist
The following checks are **mandatory**:
- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-07-07 18:17:04 +02:00
Aliaksandr Valialkin
10390a7dfc
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:43 +02:00
Aliaksandr Valialkin
45cf83cd8f
Revert "docs: Add spellcheck workflow ( #6470 )"
...
This reverts commit 92b22581e6
2024-06-25 02:23:48 +02:00
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
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
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
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
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
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
Fred Navruzov
34aa25d681
- v1.11 doc updates ( #5852 )
...
- fix dead links
2024-02-22 18:48:54 +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
Fred Navruzov
9b555a0034
update guide and changelog to 1.9.1 ( #5706 )
2024-01-28 09:43:28 +02: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
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
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
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
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
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
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
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
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
