hagen1778
cfba770c8e
docs: consistently update twitter.com to x.com
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/pull/7383
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-30 12:44:50 +01:00
hagen1778
a49eb7d4f5
docs: add step for updating VM version in docs
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/7388
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-29 18:50:40 +01:00
hagen1778
80d4acf2cf
docs: add tickets routine to release guide
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-03 09:49:07 +02:00
hagen1778
4c6b7ce6da
docs: mention to test releases before publishing them in release guide
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-10-02 16:31:11 +02:00
hagen1778
3ed172eeeb
docs: add note about testing new releases on testing env
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-09-23 11:58:43 +02:00
hagen1778
11ae873d0a
docs/release-guide: rm RPM packages from the list
...
RPM packages are now managed by community at https://github.com/VictoriaMetrics-Community/victoriametrics-rpm
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-08-30 09:49:06 +02:00
hagen1778
74e8d6ad55
docs: rm mentions of google group as it was deprecated
...
See https://docs.victoriametrics.com/#community-and-contributions
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-08-21 14:08:27 +02:00
Andrii Chubatiuk
35d77a3bed
docs: updated guides structure, removed deprecated sort option ( #6767 )
...
### Describe Your Changes
* `sort` param is unused by the current website engine, and was present only for compatibility
with previous website engine. It is time to remove it as it makes no effect
* re-structure guides content into folders to simplify assets management
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/ ).
2024-08-07 16:48:08 +02:00
Andrii Chubatiuk
2e16732fdb
docs: updated docs titles and links ( #6741 )
...
The changes are based on SEO report and supposed to improve
ranking and indexation by search engines by using prompt and unique titles
and by updating unreachable links.
It also updates links to have a simplified form and replaces relative links with absolute links
according to https://docs.victoriametrics.com/#documentation
---------
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2024-08-06 15:54:52 +02:00
hagen1778
f9d6bb91b8
docs: rm reference to step number as it could change in future
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-08-02 11:57:10 +02:00
hagen1778
93e54d65d1
docs: mention step for re-building js static files
...
Changes to .ts files in vmui or vmui for logs require re-building
static files that will be included into compiled binary afterwards.
We don't update static files on each .ts change PR because it results
in too many changes and complicates review.
So we need to update these static files before the actual release.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2024-08-02 10:56:04 +02:00
Aliaksandr Valialkin
d5809f8e12
Revert "replaced global http refs with relative markdown ones ( #6692 )"
...
This reverts commit 537266363ahttps://docs.victoriametrics.com/victorialogs/quickstart.md#building-from-source-code
link at https://docs.victoriametrics.com/victorialogs/changelog/ leads to 404 page.
This is documented at https://docs.victoriametrics.com/#images-in-documentation .
2024-07-25 12:48:12 +02:00
Andrii Chubatiuk
537266363a
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-24 07:50:09 -07:00
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
798256a655
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:21 +02:00
Andrii Chubatiuk
0a42c8fd8b
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>
2024-07-01 15:51:32 +02:00
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 d3f919df3ehttps://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
