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
Aliaksandr Valialkin
6c14d08cb3
all: replace old https://docs.victoriametrics.com/vmgateway.html url with the new one - https://docs.victoriametrics.com/vmgateway/
2024-04-18 02:08:18 +02: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
Artem Navoiev
3328b09ae8
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:30 +02:00
Artem Navoiev
9ded04e643
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 07:30:45 -08:00
Aliaksandr Valialkin
9c0863babc
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 00:17:17 +02:00
hagen1778
0a5ffb3bc1
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-18 11:19:53 +01:00
Aliaksandr Valialkin
334a739ff6
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:21:00 +02:00
Aliaksandr Valialkin
2f21c0c119
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-18 20:06:25 +02:00
Haleygo
dc28196237
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-13 13:54:33 +02:00
Artem Navoiev
636d4ea196
docs: mention the free trial for enterprise
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-10-10 01:31:48 -07:00
Artem Navoiev
507879380b
fix docs ordering
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-08-14 21:30:02 +02:00
Alexander Marshalov
2e494e2375
fixed typos in documentation and commandline flags descriptions ( #4275 )
2023-05-10 09:50:41 +02:00
Artem Navoiev
ee1da35071
prepare static docs to migration
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-30 12:33:36 +02:00
Aliaksandr Valialkin
c52c23c272
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 18:02:03 +03:00
Max Golionko
7da9443686
moved cluster dashboard to master ( #3074 )
...
dashboards: move cluster dashboard to master branch
This change should simplify dashboards management.
2022-09-06 16:19:43 +02:00
Roman Khavronenko
284bda8746
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-16 09:27:19 +02:00
Dima Lazerka
1fa0f3ec89
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:08:17 +02:00
Arash Hatami
a8de1ab000
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 13:40:55 +02:00
Denys Holius
ae89b4e818
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:30:13 +02:00
Aliaksandr Valialkin
2bc79042f6
docs: mention that enterprise binaries can be downloaded and evaluated for free
2021-08-27 12:48:14 +03:00
Aliaksandr Valialkin
e20ec090b2
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:16 +03:00
Roman Khavronenko
bd6b8f7e31
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 14:34:10 +03:00
Aliaksandr Valialkin
3bc83d3b17
docs/PerTenantStatistic.md: document that the per-tenant statistic is a part of cluster version of VictoriaMetrics
2021-06-22 12:43:01 +03:00
Roman Khavronenko
d6f44977a7
docs: update per tenant stats page ( #1246 )
2021-04-25 09:34:28 +01:00
Aliaksandr Valialkin
20b77abc17
docs: update docs order
2021-04-24 01:27:13 +03:00
Aliaksandr Valialkin
6bc52fe41a
all: rename https://victoriametrics.github.io to https://docs.victoriametrics.com
2021-04-20 20:16:17 +03:00
dereksfoster99
cf726448f2
Update PerTenantStatistic.md
2021-04-14 20:40:53 +03:00
f41gh7
e5db518c0f
updates per-tenant stats docs
...
changes docs order
changes per-tenant-stats pic
2021-04-14 12:14:51 +03:00
Artem Navoiev
e9ee2122df
[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:07 +03:00
