Hui Wang
f410520cfa
docs: fix golangci-lint check ( #6036 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
Co-authored-by: hagen1778 <roman@victoriametrics.com>
2024-04-02 23:52:50 +03:00
Nikolay
2ee8e462f8
docs/opentelemetry: adds opentemetry get started guide ( #5861 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
Co-authored-by: Andrii Chubatiuk <andrew.chubatiuk@gmail.com>
2024-04-02 23:47:06 +03:00
hagen1778
a4cdfaea28
docs: clarify deduplication is needed in multi-retention setup
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-03-06 13:33:40 +02: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
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
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
Aliaksandr Valialkin
3230525c36
docs: use persistent links to Grafana dashboards
...
These links do not depend on the dashboard name, so they do not break after the renaming of the dashboard.
This is a follow-up for ff33e60a3d
2024-01-22 01:45:42 +02:00
hagen1778
a99d26633b
docs: remove slug from Grafana dashboard URLs
...
Each Grafana dashboard has unique ID which can be used to fetch the dashboard
from grafana.com: https://grafana.com/grafana/dashboards/11176
The same dashboard can be accessed via URL with slug: https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/
But using slug implies that any change to dashboard name will break the link.
So it is better to just use ID, so the dashboard URL will never break.
This is follow-up for ff33e60a3d
2024-01-22 00:23:30 +02:00
Artem Navoiev
70743c7014
fix link for grafana dashbaord for single node after its renaming
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-22 00:21:57 +02:00
hagen1778
07a55a484a
docs/setup-size: rm tolerable churn rate %
...
It is likely this value was borrowed from panel `Slow inserts` panel
from Grafana dasbhoard for VM single/cluster installations. This is a mistake.
There is no such thing as "tolerable churn rate", as tolerancy depends on the amount
of allocated resources.
Although, it is unclear what is meant by 5%. If it refers to 5% of new time series per second,
then such churn rate is extremely high. It would mean that the avg life of a time series is 20s.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-01-21 23:48:24 +02:00
Fred Navruzov
99c545bff8
- fix 404 in /guides page ( #5582 )
...
- change back AD section title
2024-01-16 19:50:01 +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
Daria Karavaieva
372553479a
docs: vmanomaly guide v1.7.0 changes ( #5505 )
...
(cherry picked from commit be20501376
2023-12-22 16:10:32 +01:00
hagen1778
49bd8adbc3
docs: mention Splitting data streams in Multi-retention guide
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-12-19 03:24:12 +02:00
Aliaksandr Valialkin
2f02c87b02
docs: run make docs-images-to-webp after 02a0a7f428
...
This reduces added image sizes by 3x
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5437
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5370
2023-12-07 16:42:16 +02:00
Alexander Marshalov
e9cf39f519
added field version to the response for /api/v1/status/buildinfo API for using more efficient API in Grafana for receiving label values, added additional info about setup Grafana datasource ( #5370 ) ( #5437 )
2023-12-07 16:41:56 +02:00
Aliaksandr Valialkin
db6dadf1f7
docs: convert png images to webp in all the docs except of docs/operator/*
...
This reduces the size of docs/* folder from 33MB to 18MB
Images inside docs/operator/* must be converted at the https://github.com/VictoriaMetrics/operator/tree/master/docs
and then the updated images must be automatically propagated to the docs/operator/*
This is a follow-up for d3f919df3ehttps://github.com/VictoriaMetrics/VictoriaMetrics/pull/5206
2023-11-22 19:29:47 +02:00
Aliaksandr Valialkin
ea254edb44
deployment: update VictoriaMetrics tag from v1.93.1 to v1.93.2
...
See https://docs.victoriametrics.com/CHANGELOG.html#v1932
2023-09-01 17:36:01 +02:00
hagen1778
1464dda198
docs: fix typo for deduplication description in k8s guide
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
(cherry picked from commit a20234d2d0
2023-08-28 21:32:42 +02:00
Daria Karavaieva
c730e1ed0c
vmanomaly guide docker compose run fix according licensing ( #4876 )
...
* docker-compose run fix according to licensing
* public v1.5.0 of vmanomaly
* new file list image
* 1.93.1 version of VM
2023-08-28 09:23:54 +02:00
hagen1778
be7001351c
alerts: add docs section for the full list of alerting rules
...
The change also includes update of all references in other docs
to the alerting rules.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-08-11 04:38:30 -07:00
Aliaksandr Valialkin
1b7d97787a
docs: use 1. instead of N. in numbered bullets, so they are automatically adjusted by Github Markdown engine
...
See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 14:40:06 -07:00
Zakhar Bessarab
5b3000f7e8
docs: fix broken link to managed VM ( #4679 )
...
Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-20 21:49:06 -07:00
Artem Navoiev
756f0e1545
docs: change images from markdown tag to html for migration
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
(cherry picked from commit 8a4c89ea22
2023-06-02 13:28:04 +02:00
Roman Khavronenko
a0825ca5cd
docs: mention multi-tenancy in docs ( #4357 )
...
The update should make understanding of multi-tenancy more clear
for influxdb users.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
(cherry picked from commit 1c3f50f791
2023-06-02 13:28:02 +02:00
Artem Navoiev
ec97b851bb
remove absolute links, fix aliase
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
(cherry picked from commit 434358b551
2023-06-02 13:19:33 +02:00
Artem Navoiev
db3d34ca9a
fix title in multi-regional-setup-dedicated-regions.md
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
(cherry picked from commit c1ad48edf9
2023-06-02 13:19:33 +02:00
Aliaksandr Valialkin
b73a2336f0
deployment/docker: update VictoriaMetrics version from v1.90.0 to v1.91.0 in docker compose files
2023-05-18 15:34:54 -07:00
Alexander Marshalov
d321ea91f2
fixed typos in documentation and commandline flags descriptions ( #4275 )
2023-05-10 02:22:06 -07:00
Artem Navoiev
46886260be
prepare operator docs to migration
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-08 21:59:48 -07:00
Alexander Marshalov
7faf45d7f9
doc improvements ( #4172 ) ( #4186 )
...
- added info about metric `vm_vminsert_metrics_read_total`,
- small doc refactoring
- and added make-command for running docs in docker.
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-05-08 13:11:57 -07:00
Aliaksandr Valialkin
b21ac56894
docs/guides: update VictoriaMetrics from v1.89.1 to v1.90.0
2023-04-06 19:18:14 -07:00
Artem Navoiev
1b05896ac5
fix closing divs in docs
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-05 13:30:14 -07:00
Daria Karavaieva
83213e6786
Vmanomaly guide index fix ( #4029 )
...
* name and scrutture change
* fix indexing
* index fix
* name change
* line separator fix
2023-03-31 22:32:15 -07:00
Daria Karavaieva
53c3d6137f
Vmanomaly guide ( #3834 )
...
Setting up VMAnomaly on NodeExporter metrics with VictoriaMetrics and AlertManager.
* vmanomaly-guide-draft
* aletr graphs and description
* readme vmanomaly tutorial
* Added back fit_every param for performance
* vmanomaly guide fixes
* added spaces div
* spaces + resize image
* alert example grammar
* quotation marks
* docker link
* typo fixed
* more links
* reader section rephrased
* label change
* lower case for grafana service
* lower case for vm service
* yaml markdown
---------
Co-authored-by: Dima Lazerka <dima@victoriametrics.com>
2023-03-24 17:54:10 -07:00
Zakhar Bessarab
c397e56769
doc/vmgateway-grafana-openid-guide: fix formatting, add reproducible example and example results ( #3964 )
2023-03-17 16:15:45 -07:00
Zakhar Bessarab
a3f364869f
doc: add guide for vmgateway configuration with OpenID and Grafana ( #3951 )
...
docs: add guide for vmgateway configuration with OpenID and Grafana
2023-03-14 16:11:29 -07:00
panguicai
1b75d66bcd
docs: update operator release name to be consistent with the following ( #3845 )
...
Signed-off-by: panguicai008 <1121906548@qq.com>
2023-02-21 17:42:39 -08:00
Aliaksandr Valialkin
04ce4c4762
docs/guides/migrate-from-influx.md: remove misleading doublequotes from the query example
2023-02-20 19:25:07 -08:00
Max Golionko
76d339b886
add guide to list of guides
2023-02-03 10:45:01 -08:00
Denys Holius
41ea90e6a2
guides/guide-delete-or-replace-metrics.md: fixed wrong curl command ( #3652 )
2023-01-15 13:03:32 -08:00
Corporte Gadfly
5815a98957
docs: fix typo ( #3648 )
2023-01-15 13:01:23 -08:00
Artem Navoiev
9d85c62ce2
Add Understand Your Setup Size Guide ( #3572 )
...
docs: add Understand Your Setup Size Guide
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-01-05 16:48:28 -08:00
Artem Navoiev
393f4ab86f
update links to grafana dashboards ( #3534 )
...
docs: update links to grafana dashboards
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2022-12-28 11:22:02 -08:00
Denys Holius
c09cee96ca
guides/README.md: fix link to guide-delete-or-replace-metrics.html ( #3331 )
2022-11-09 12:01:23 +02:00
Aliaksandr Valialkin
56ef9f2d88
docs/guides/guide-vmcluster-multiple-retention-setup.md: clarify docs after a75d85b11e
2022-11-05 10:09:11 +02:00
Artem Navoiev
b030662e3e
update multi-tenancy guide. Add infromation about Enterprise and Rete… ( #3285 )
...
docs: update multi-tenancy guide
Add information about Enterprise and Retention Filters
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2022-11-05 10:09:11 +02:00
Denys Holius
8c0f93aa55
Docs: add guide "How to delete and replace metrics" ( #2829 )
...
docs: add guide how to delete and replace metrics
2022-10-25 17:54:13 +03:00
Aliaksandr Valialkin
608c977978
docs/guides/migrate-from-influx.md: properly display images at https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/guides/migrate-from-influx.md
...
This is a follow-up for 42375679db
2022-10-24 21:29:55 +03:00
Aliaksandr Valialkin
8ea84432ef
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 18:03:22 +03:00
