From 6857736f04cea76e4ffd59b0198852210b5a3a83 Mon Sep 17 00:00:00 2001 From: Roman Khavronenko Date: Mon, 11 Nov 2024 00:54:46 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20recommend=20using=20`available=5Ffrom`?= =?UTF-8?q?=20in=20CONTRIBUTING=20and=20release=20gu=E2=80=A6=20(#7493)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit …ides ### Describe Your Changes Please provide a brief description of the changes you made. Be as specific as possible to help others understand the purpose and impact of your modifications. ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). Signed-off-by: hagen1778 --- docs/CONTRIBUTING.md | 3 ++- docs/Release-Guide.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ab352c2fe..909cdbe7d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -63,7 +63,8 @@ A pull request should contain the following attributes: To run tests and code checks locally execute commands `make tests-full` and `make check-all`. 1. Try to not extend the scope of the pull requests outside the issue, do not make unrelated changes. 1. Documentation update, if needed. For example, adding a new flag or changing behavior of existing flags or features - requires reflecting these changes in the documentation. + requires reflecting these changes in the documentation. For new features add `{{%/* available_from "#" */%}}` shortcode + to the documentation. It will be later automatically replaced with an actual release version. 1. A line in the [changelog](https://docs.victoriametrics.com/changelog/#tip) mentioning the change and related issue in a way that would be clear to other readers even if they don't have the full context. 1. Reviewers who you think have the best expertise on the matter. diff --git a/docs/Release-Guide.md b/docs/Release-Guide.md index a9d7166a4..282aca257 100644 --- a/docs/Release-Guide.md +++ b/docs/Release-Guide.md @@ -47,7 +47,7 @@ Bumping the limits may significantly improve build speed. Changes in these branches must be synced immediately after they are committed in at least a single branch. 1. Make sure that the release branches have no security issues. 1. Update release versions if needed in [SECURITY.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/SECURITY.md). -1. Add `(available starting from v1.xx.y)` line to feature docs introduced in the upcoming release. +1. Run `PKG_TAG=v1.xx.y make docs-update-version` command to update version help tooltips. 1. Cut new version in [CHANGELOG.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md) and make it merged. See example in this [commit](https://github.com/VictoriaMetrics/VictoriaMetrics/commit/b771152039d23b5ccd637a23ea748bc44a9511a7). 1. Cherry-pick bug fixes relevant for [LTS releases](https://docs.victoriametrics.com/lts-releases/).