Andrii Chubatiuk
6b97044d8a
view documentation locally ( #6677 )
...
- moved files from root to VictoriaMetrics folder to be able to mount
operator docs and VictoriaMetrics docs independently
- added ability to run website locally
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-07-25 12:27:05 +02:00
Aliaksandr Valialkin
2ec18a6634
all: replace old https://docs.victoriametrics.com/vmgateway.html url with the new one - https://docs.victoriametrics.com/vmgateway/
2024-04-18 02:08:53 +02: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
Artem Navoiev
3d9f947e42
docs: update statistic per tenant, add use cases section ( #5892 )
...
* docs: update statistic per tenant, add use cases section
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* prettify
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* Update docs/PerTenantStatistic.md
---------
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2024-02-29 14:55:55 +02:00
Artem Navoiev
aee3e51315
docs: remove raw and endraw tags as they are not needed for the new v… ( #5696 )
...
* docs: remove raw and endraw tags as they are not needed for the new version of site
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* revert formating in vmaler
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
---------
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-26 21:06:10 +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
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
94e061087f
docs: use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest instead of https://github.com/VictoriaMetrics/VictoriaMetrics/releases link where needed
...
The https://github.com/VictoriaMetrics/VictoriaMetrics/releases link may show non-latest
releases at the top, such as LTS releases or VictoriaLogs releases.
So it is better to use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest link,
which always redirect to the latest available release of VictoriaMetrics.
2023-10-26 09:23:17 +02:00
Haleygo
130e0ea5f0
vmalert-tool: implement unittest ( #4789 )
...
1. split package rule under /app/vmalert, expose needed objects
2. add vmalert-tool with unittest subcmd
https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2945
2023-10-16 14:12:06 +02:00
Artem Navoiev
d8c8a66c79
docs: mention the free trial for enterprise
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
(cherry picked from commit 636d4ea196
2023-10-10 12:45:08 +02:00
Artem Navoiev
8ed8dba1b3
fix docs ordering
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
(cherry picked from commit 507879380b
2023-08-15 09:21:30 +02:00
Alexander Marshalov
d321ea91f2
fixed typos in documentation and commandline flags descriptions ( #4275 )
2023-05-10 02:22:06 -07:00
Artem Navoiev
283a75afba
prepare static docs to migration
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-08 21:54:20 -07: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
Max Golionko
e07f23a1b9
moved cluster dashboard to master ( #3074 )
...
dashboards: move cluster dashboard to master branch
This change should simplify dashboards management.
2022-09-08 11:47:25 +03:00
Roman Khavronenko
ee1f8bae2e
docs: fix liquid syntax errors ( #2592 )
...
For liquid text processor double braces `{{` `}}`
are special chars for templating.
Since we use them in some of our docs with different purpose,
we must escape them to avoid syntax errors from liquid.
For escaping curly braces we use bult-in plugin which helps
to enclose sections of text via `{% raw %}` and `{% endraw %}`.
This approach prevents liquid syntax errors and makes render correct.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-05-20 13:42:47 +03:00
Dima Lazerka
6e8e385375
VMAnomaly docs fixes ( #2361 )
...
* Added docs for vmanomaly
* Add example images
* Stylistic fixes
* Move images to root
* Update docs/vmanomaly.md
* Update docs/vmanomaly.md
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
* Squeeze vmanomaly after vmbackupmanager before Case Studies
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2022-03-25 12:09:05 +02:00
Arash Hatami
2e01691d5d
A good change for MD files ( #2353 )
...
* Lint YAML
* Remove extra comment
* Fix command problem
* Format MD files
* Format & fix problem of MD files for docs
* Another fix for MD files
2022-03-22 14:01:04 +02:00
Denys Holius
3a522c591a
Old links replaced for newest ( #2033 )
...
* replaced old links to the website
* fixed deletion main README.md file
* fix: added docs files after docs-sync
2022-01-05 16:32:54 +02:00
Aliaksandr Valialkin
125a94e6ca
docs: mention that enterprise binaries can be downloaded and evaluated for free
2021-08-27 12:48:51 +03:00
Aliaksandr Valialkin
c582d95cf0
docs: remove SampleSizeCalculations.md, since it is outdated and no longer used
...
There was a reference to this doc from the old victoriametrics.com site
2021-07-28 19:25:45 +03:00
Roman Khavronenko
e2b5f93170
move github-pages docs to the main repo ( #1432 )
...
* move github-pages docs to the main repo
* rm github actions for copying docs to VictoriaMetrics/VictoriaMetrics.github.io
2021-07-05 15:20:29 +03:00
Aliaksandr Valialkin
a575882ca2
docs/PerTenantStatistic.md: document that the per-tenant statistic is a part of cluster version of VictoriaMetrics
2021-06-22 12:43:30 +03:00
Roman Khavronenko
2357e21024
docs: update per tenant stats page ( #1246 )
2021-04-27 00:16:44 +03:00
Aliaksandr Valialkin
2bd99046a1
docs: update docs order
2021-04-24 01:28:13 +03:00
Aliaksandr Valialkin
6dc5d3b357
all: rename https://victoriametrics.github.io to https://docs.victoriametrics.com
2021-04-20 20:20:01 +03:00
dereksfoster99
1b6d2467ff
Update PerTenantStatistic.md
2021-04-16 10:58:51 +03:00
f41gh7
b493937815
updates per-tenant stats docs
...
changes docs order
changes per-tenant-stats pic
2021-04-14 12:31:51 +03:00
Artem Navoiev
39b5de9f24
[draft] per tenant statistic ( #121 )
...
* [draft] per tenant statistic
* updates metric name
update graph
adds link and example config
* quick fix
* adds grafana dashboard
adds example alert
Co-authored-by: f41gh7 <nik@victoriametrics.com>
2021-04-14 11:23:41 +03:00
