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
Andrii Chubatiuk
7958f38864
deployment/docker: allow cross-platform building on arm64 platform ( #6158 )
...
Added x86_64 libraries to allow building cross-platform images on arm64
2024-04-23 12:12:10 +02:00
yudrywet
43835704b7
chore: fix some typos in comments ( #6103 )
...
Signed-off-by: yudrywet <yudeyao@yeah.net>
2024-04-16 09:48:52 +02:00
Aliaksandr Valialkin
47d1ea1d3a
docs: consistently use https://docs.victoriametrics.com/lts-releases/ link for LTS releases
2024-03-01 02:51:41 +02:00
Aliaksandr Valialkin
0c88ba326f
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:11:46 +02:00
hagen1778
6c6c2c185f
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-27 19:29:11 +01:00
Artem Navoiev
25165656bb
docs: change [image] to img as far we support it in release guide
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2024-01-26 19:01:20 +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 d3f919df3e
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5206
2023-11-22 19:21:00 +02:00
Aliaksandr Valialkin
a79a439dac
docs/Release-Guide.md: point to the proper location for CHANGELOG.md at github.com/VictoriaMetrics/operator repository
2023-11-15 21:55:45 +01:00
hagen1778
60eab8e2ef
docs: fix typo
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-10-14 07:46:00 +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
Alexander Marshalov
eebef296d4
Updates in release guide ( #4956 )
...
new helm release flow and operator release flow
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-09-11 09:55:30 +02:00
Artem Navoiev
507879380b
fix docs ordering
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-08-14 21:30:02 +02:00
Aliaksandr Valialkin
38e72ea344
docs/Release-Guide.md: document that changes must be synced between branches immediately after the commit in any branch
2023-08-11 04:29:04 -07:00
hagen1778
9abf8535ac
docs: add link to release-guide follow-up
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-31 14:05:17 +02:00
hagen1778
b4fca28c29
docs: fix step references in Release-Guide.md
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-28 11:44:41 +02:00
Aliaksandr Valialkin
f592be2191
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:08:27 -07:00
Roman Khavronenko
399dc39ee9
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:55:10 -07:00
Roman Khavronenko
c8f9fab3cb
docs/ReleaseGuide: mention auth for Docker ( #4453 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-06-15 09:59:10 +02:00
Roman Khavronenko
1471641cbd
docs/release-guide: update instructions ( #4391 )
...
docs/release-guide: update instructions for MacOS users
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-06-13 10:37:51 +02:00
Aliaksandr Valialkin
f0ed9ab4f2
docs/Release-Guide.md: fix a link to sandbox environment
...
The link became broken after 5f9d3f9cb5
2023-05-18 15:30:07 -07: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
Denys Holius
f3cb412508
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 14:32:26 +01:00
Denys Holius
d513230d43
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 16:03:42 +01:00
Denys Holius
b06e795a1e
docs/Release-Guide.md: added missed link to rpm repository ( #3623 )
2023-01-10 10:14:56 +01:00
Denys Holius
09fe346d18
docs/Release-Guide.md: adds release scenario for RPM LTS packages ( #3588 )
2023-01-04 14:36:14 +01:00
Aliaksandr Valialkin
a48510573e
Revert "docs/Release-Guide.md: add LATEST_TAG=stable env var for make publish-release
in order to create stable
tag for the published components at DockerHub"
...
This reverts commit 8afa7ef837
.
2022-12-20 12:24:27 -08:00
Aliaksandr Valialkin
8afa7ef837
docs/Release-Guide.md: add LATEST_TAG=stable env var for make publish-release
in order to create stable
tag for the published components at DockerHub
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2911
2022-12-20 12:22:42 -08:00
Aliaksandr Valialkin
a1011931ac
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:31:02 +02:00
Max Golionko
d67948b8e3
added security policy ( #3140 )
...
* added security policy
* Update SECURITY.md
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-09-26 16:47:02 +03:00
Aliaksandr Valialkin
b9231c715a
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:18 +03:00
Max Golionko
c685afebb2
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:27:24 +03:00
Aliaksandr Valialkin
90649de0c4
docs/Release-Guide.md: document that feature docs must be updated with the release where the feature appeared
2022-07-30 00:15:49 +03:00
Roman Khavronenko
b875628ae6
docs: mention sandbox update in release procedure ( #2724 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-06-16 20:48:01 +03:00
Aliaksandr Valialkin
84326eacd6
docs/Release-Guide.md: typo fix: signle->single
2022-05-09 15:27:44 +03:00
Aliaksandr Valialkin
cde1e2ec93
docs/Release-Guide.md: add missing steps
2022-04-06 11:41:09 +03:00
Artem Navoiev
3d3b9e3b59
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:14:27 +03: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
Aliaksandr Valialkin
15475a9d1f
docs/Release-Guide.md: add instructions on how to create signed release tags
2022-01-31 19:18:48 +02:00
Aliaksandr Valialkin
56168d8565
docs/Release-Guide.md: update instructions for exporting snapcraft login to ~/.snap/login.json
2022-01-19 15:20:59 +02:00
Aliaksandr Valialkin
64da5c2bf6
docs/Release-Guide.md: refresh the list of channels for publishing release notes
2021-12-08 13:15:05 +02:00
Aliaksandr Valialkin
b07010839c
Makefile: add TAG=v... make publish-release
rule for building and publishing a release for the given TAG
2021-11-08 12:29:10 +02: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
Aliaksandr Valialkin
00deb69e28
docs: ordering fix
2021-04-24 02:28:53 +03:00
Aliaksandr Valialkin
20b77abc17
docs: update docs order
2021-04-24 01:27:13 +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
Roman Khavronenko
c6a8ebb11f
docs: update docs ordering and formatting ( #1192 )
...
The major change is adding `sort` directive to docs. For those docs which are copied
from internal packages `sort` is added via makefile command. For the rest it is added
manually since they're updated manually as well.
The rest of changes is connected with markdown formatting. For example, changing headers
in some files (`##` => `#`) makes navigation on .github.io to look better. This especially
useful for `changelog` docs.
Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io.
No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 13:39:16 +03:00
Nikolay
85962b459f
Snap docs change ( #986 )
...
* adds snap docs,
adds release information for snap package,
adds docs notes about configuration management with snap package.
* adds release page mention
* version fix for snap, its awful
* revert version
* Apply suggestions from code review
Co-authored-by: Aliaksandr Valialkin <valyala@gmail.com>
2020-12-29 11:43:09 +02:00