From 466cbee43304cd81285788aec302ae28a8ab4dad Mon Sep 17 00:00:00 2001 From: Viet Hung Nguyen Date: Wed, 27 Nov 2024 16:04:21 +0900 Subject: [PATCH] docs: fix rule unittest rule_files point to alerts.yaml (#7664) ### Describe Your Changes Fix wrong path to rules_file in vmalert-tool doc ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). Signed-off-by: Viet Hung Nguyen Co-authored-by: Hui Wang --- docs/vmalert-tool.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/vmalert-tool.md b/docs/vmalert-tool.md index 24dc55827..99f1e28f6 100644 --- a/docs/vmalert-tool.md +++ b/docs/vmalert-tool.md @@ -197,9 +197,9 @@ value: ### Example This is an example input file for unit testing which will pass. -`test.yaml` is the test file which follows the syntax above and `alerts.yaml` contains the alerting rules. +`test.yaml` is the test file which follows the syntax above and `rules.yaml` contains the alerting rules. -With `rules.yaml` in the same directory, run `./vmalert-tool unittest --files=./unittest/testdata/test.yaml -external.label=cluster=prod`. +With `rules.yaml` in the same directory with `test.yaml`, run `./vmalert-tool unittest --files=./unittest/testdata/test.yaml -external.label=cluster=prod`. #### `test.yaml` @@ -249,7 +249,7 @@ tests: exp_alerts: [] ``` -#### `alerts.yaml` +#### `rules.yaml` ```yaml # This is the rules file.