Andrii Chubatiuk
b8d80ddae5
replaced global http refs with relative markdown ones ( #6692 )
...
### Describe Your Changes
Replaced global http links in docs with relative markdown ones
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-07-25 13:26:51 +02:00
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
3cda945138
docs/Release-Guide.md: shorten release guide for Ansible roles and RPM packages
...
There is no need in enumerating all the files, which must be updated, since these files
may be moved to other locations. It is enough to mention that versions for all the VictoriaMetrics
components must be updated.
2024-07-17 23:36:30 +02:00
Andrii Chubatiuk
65c742d976
deployment: remove snap packages support ( #6543 )
...
### Describe Your Changes
Removed snap packages support as it requires time for maintenance and
it's not popular at all
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
---------
Signed-off-by: hagen1778 <roman@victoriametrics.com>
Co-authored-by: hagen1778 <roman@victoriametrics.com>
(cherry picked from commit 0a42c8fd8b
2024-07-01 16:40:39 +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
Andrii Chubatiuk
29f9b8ef5d
deployment/docker: allow cross-platform building on arm64 platform ( #6158 )
...
Added x86_64 libraries to allow building cross-platform images on arm64
(cherry picked from commit 7958f38864
2024-04-23 14:52:30 +02:00
yudrywet
d89229c838
chore: fix some typos in comments ( #6103 )
...
Signed-off-by: yudrywet <yudeyao@yeah.net>
(cherry picked from commit 43835704b7
2024-04-16 09:58:30 +02:00
Aliaksandr Valialkin
e4a1d6774e
docs: consistently use https://docs.victoriametrics.com/lts-releases/ link for LTS releases
2024-03-01 02:52:41 +02:00
Aliaksandr Valialkin
7d619deacc
docs/Release-Guide.md: https://github.com/VictoriaMetrics/victoriametrics-lts-rpm should contain the latest release
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5811
2024-02-27 13:14:25 +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
bb5a0719a5
docs: change [image] to img as far we support it in release guide
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-26 21:09:22 +01: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
772d2081ca
docs/Release-Guide.md: point to the proper location for CHANGELOG.md at github.com/VictoriaMetrics/operator repository
2023-11-15 21:56:11 +01: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
hagen1778
5f621b2fa1
docs: fix typo
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-10-16 13:25:05 +02:00
Alexander Marshalov
c57ce9a55a
Updates in release guide ( #4956 )
...
new helm release flow and operator release flow
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-09-11 23:51:27 +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
Aliaksandr Valialkin
ca49f23a45
docs/Release-Guide.md: document that changes must be synced between branches immediately after the commit in any branch
2023-08-11 05:46:04 -07:00
hagen1778
ee13ee1658
docs: add link to release-guide follow-up
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-31 07:48:13 -07:00
hagen1778
418042cae2
docs: fix step references in Release-Guide.md
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-28 11:16:59 -07:00
Aliaksandr Valialkin
64ef01fccf
docs/Release-Guide.md: 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:12:32 -07:00
Roman Khavronenko
92cd98e366
docs: mention tags routing for new release ( #4566 )
...
* docs: mention tags routing for new release
Signed-off-by: hagen1778 <roman@victoriametrics.com>
* Update docs/Release-Guide.md
---------
Signed-off-by: hagen1778 <roman@victoriametrics.com>
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-07-19 16:56:04 -07:00
Roman Khavronenko
3937da289a
docs/ReleaseGuide: mention auth for Docker ( #4453 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-06 17:02:07 -07:00
Roman Khavronenko
0e0b7bf87f
docs/release-guide: update instructions ( #4391 )
...
docs/release-guide: update instructions for MacOS users
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-06 16:54:46 -07:00
Aliaksandr Valialkin
63540f3ff1
docs/Release-Guide.md: fix a link to sandbox environment
...
The link became broken after 5f9d3f9cb5
2023-05-18 15:34:52 -07: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
Denys Holius
0f25a77acd
Fix/remove vmanomaly from release guide ( #3699 )
...
* docs/Release-Guide.md: remove vmanomaly from release guide because it has own release cycle
* fixed a typo
2023-01-23 08:08:02 -08:00
Denys Holius
4429e7e53e
Adds some improvements to release guide docs ( #3679 )
...
* docs/Release-Guide.md: fixed a typo
* Release-Guide.md: adds missed steps for updating vmanomaly and vmgateway helm charts
2023-01-19 10:01:54 -08:00
Denys Holius
ceea223caa
docs/Release-Guide.md: added missed link to rpm repository ( #3623 )
2023-01-10 13:43:45 -08:00
Denys Holius
28649f0773
docs/Release-Guide.md: adds release scenario for RPM LTS packages ( #3588 )
2023-01-04 08:39:10 -08:00
Aliaksandr Valialkin
616c9f1fb0
docs/Release-Guide.md: instruct to update VictoriaMetrics version in deployment/docker/docker-compose*.yml files after creating new release
...
This is a follow-up for d1509f4559
2022-11-01 10:32:02 +02:00
Max Golionko
322e5006d2
added security policy ( #3140 )
...
* added security policy
* Update SECURITY.md
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-26 16:47:38 +03:00
Aliaksandr Valialkin
f6b3ad0c37
docs/Release-Guide.md: require manual push of the created release tags to public Github
...
The automated push of release tags to Github require specifying the remote repository name
when doing `git push <remote-repo-name> v1.xx.y`.
The remote repository name can differ in different environments,
so it cannot be put into Makefile rule.
TODO: create a Makefile rule, which generates standard remote names for public
and private repositories in Git, so `git push` for release tags could be automated then.
2022-09-08 15:00:34 +03:00
Max Golionko
0359fce052
simplify release process ( #3012 )
...
* simplify release process
* address comments
* address comments
* wip
* wip
* wip
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-08-31 02:28:45 +03:00
Aliaksandr Valialkin
f1a49fe779
docs/Release-Guide.md: document that feature docs must be updated with the release where the feature appeared
2022-07-30 00:16:34 +03:00
Roman Khavronenko
287bb96758
docs: mention sandbox update in release procedure ( #2724 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-06-16 20:51:41 +03:00
Aliaksandr Valialkin
86d344f6c0
docs/Release-Guide.md: typo fix: signle->single
2022-05-09 15:27:57 +03:00
Aliaksandr Valialkin
087609a12b
docs/Release-Guide.md: add missing steps
2022-04-06 11:41:42 +03:00
Artem Navoiev
23614d752a
Update release process. Actualize helm-charts release process. Add re… ( #2397 )
...
* Update release process. Actualize helm-charts release process. Add release guide for ansible playbooks
* add step to Ansible steps
2022-04-04 12:56:11 +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
Aliaksandr Valialkin
ad5d646e4e
docs/Release-Guide.md: add instructions on how to create signed release tags
2022-01-31 20:25:15 +02:00
Aliaksandr Valialkin
d9ab623c5b
docs/Release-Guide.md: update instructions for exporting snapcraft login to ~/.snap/login.json
2022-01-19 15:21:49 +02:00
Aliaksandr Valialkin
e21d1353f4
docs/Release-Guide.md: refresh the list of channels for publishing release notes
2021-12-08 13:16:09 +02:00
Aliaksandr Valialkin
7cbb81c2a6
Makefile: add TAG=v... make publish-release rule for building and publishing a release for the given TAG
2021-11-08 12:29:24 +02: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
Aliaksandr Valialkin
97424c05c0
docs: ordering fix
2021-04-24 02:29:30 +03:00
Aliaksandr Valialkin
2bd99046a1
docs: update docs order
2021-04-24 01:28:13 +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
