Merge pull request #56 from flashcatcloud/docs/description-template-menu-label

docs: adjust description template menu label

Author: UlricQin

.mintignore

@@ -4,4 +4,5 @@
 # Project documentation (non-mdx files)
 AGENTS.md
 README.md
+README_zh.md
 README.en.md

docs.json

@@ -448,7 +448,6 @@
                 "group": "告警规则",
                 "icon": "list-check",
                 "pages": [
-                  "zh/monitors/alert-rules/description-template",
                   "zh/monitors/alert-rules/prometheus",
                   "zh/monitors/alert-rules/elasticsearch",
                   "zh/monitors/alert-rules/loki",
@@ -457,7 +456,8 @@
                   "zh/monitors/alert-rules/oracle",
                   "zh/monitors/alert-rules/postgres",
                   "zh/monitors/alert-rules/sls",
-                  "zh/monitors/alert-rules/victorialogs"
+                  "zh/monitors/alert-rules/victorialogs",
+                  "zh/monitors/alert-rules/description-template"
                 ]
               },
               {
@@ -1400,7 +1400,6 @@
                 "group": "Alert Rules",
                 "icon": "list-check",
                 "pages": [
-                  "en/monitors/alert-rules/description-template",
                   "en/monitors/alert-rules/prometheus",
                   "en/monitors/alert-rules/elasticsearch",
                   "en/monitors/alert-rules/loki",
@@ -1409,7 +1408,8 @@
                   "en/monitors/alert-rules/oracle",
                   "en/monitors/alert-rules/postgres",
                   "en/monitors/alert-rules/sls",
-                  "en/monitors/alert-rules/victorialogs"
+                  "en/monitors/alert-rules/victorialogs",
+                  "en/monitors/alert-rules/description-template"
                 ]
               },
               {

en/monitors/alert-rules/description-template.mdx

@@ -1,14 +1,18 @@
 ---
-title: "Alert Rule Description Templates"
+title: "Description Template"
 description: "Configure Go Template variables, related query results, and Sprig functions for Monitors alert rule descriptions."
 keywords: ["Description templates", "alert rules", "Go Template", "Sprig", "related queries"]
 ---
 
 Use an alert rule **Description** to define the text shown on firing and recovery events. You can reference alert labels, query values, related query results, and safe Sprig functions with Go `text/template`, then render the result as Text or Markdown.
 
+<Warning>
+The template variables, Sprig function names, and behavior where label enrichment runs before `Description` rendering require monit-edge `v0.42.0` or later. On older versions, some variables or functions may be unavailable, and enrichment results may not be available inside Description templates.
+</Warning>
+
 ## How It Works
 
-When a rule fires or recovers, monit-edge passes the full alert event as the template root object and injects short variables for common fields. After rendering, monit-edge writes the result to the event `Description`, then runs label enrichment and sends the event.
+When a rule fires or recovers, monit-edge passes the full alert event as the template root object and injects short variables for common fields. After label enrichment completes, monit-edge renders the template with the enriched event, writes the result to the event `Description`, and then sends the event.
 
 <Note>
 For day-to-day templates, prefer `$labels`, `$values`, `$value`, `$relates`, `$status`, and `$checkMode`. Use the other short variables only for advanced templates or compatibility cases.
@@ -224,7 +228,7 @@ community_posts.comment_count
 | `contains substr text` | Checks whether `text` contains `substr`. | `{{ if contains "Unknown column" $msg }}...{{ end }}` |
 | `hasPrefix prefix text` | Checks prefix. | `{{ hasPrefix "prod-" $name }}` |
 | `hasSuffix suffix text` | Checks suffix. | `{{ hasSuffix ".log" $file }}` |
-| `regexMatch pattern text` | Regex match. | `{{ regexMatch "error|failed" $msg }}` |
+| `regexMatch pattern text` | Regex match. | `{{ regexMatch "error\|failed" $msg }}` |
 | `regexFind pattern text` | Returns the first full regex match. | `{{ regexFind "trace_id=[a-z0-9]+" $msg }}` |
 | `regexFindAll pattern text n` | Returns up to `n` full regex matches. Use `-1` for all. | `{{ regexFindAll "id=[0-9]+" $msg -1 }}` |
 | `regexReplaceAll pattern text repl` | Regex replacement. Argument order is `pattern`, `text`, `replacement`. | `{{ regexReplaceAll ".*id=([0-9]+).*" $msg "$1" }}` |

zh/monitors/alert-rules/description-template.mdx

@@ -1,14 +1,18 @@
 ---
-title: "告警规则 Description 模板"
+title: "备注模板"
 description: "配置 Monitors 告警规则备注描述的 Go Template 变量、关联查询结果和 Sprig 函数。"
 keywords: ["Description 模板", "告警规则", "备注描述", "Go Template", "Sprig", "关联查询"]
 ---
 
 Monitors 告警规则的 **备注描述（Description）** 用于定义告警和恢复事件中的说明文本。你可以使用 Go `text/template` 引用告警标签、查询值、关联查询结果和安全的 Sprig 函数，生成 Text 或 Markdown 格式的描述内容。
 
+<Warning>
+本文描述的模板变量、Sprig 函数名和标签增强后再渲染 `Description` 的行为需要 monit-edge `v0.42.0` 或以上版本。低于该版本时，部分变量或函数可能不可用，标签增强结果也可能无法在备注模板中引用。
+</Warning>
+
 ## 工作方式
 
-规则触发或恢复时，monit-edge 会把完整告警事件作为模板根对象，并额外注入一组常用短变量。模板渲染完成后，结果会写入事件的 `Description` 字段，再继续执行标签增强和事件发送。
+规则触发或恢复时，monit-edge 会把完整告警事件作为模板根对象，并额外注入一组常用短变量。标签增强执行完成后，模板会基于增强后的事件渲染，结果会写入事件的 `Description` 字段，再继续发送事件。
 
 <Note>
 日常模板建议优先使用 `$labels`、`$values`、`$value`、`$relates`、`$status` 和 `$checkMode`。其他短变量用于高级模板或兼容场景，只有确实需要时再使用。
@@ -215,7 +219,7 @@ community_posts.comment_count
 | `contains substr text` | 判断 `text` 是否包含 `substr`。 | `{{ if contains "Unknown column" $msg }}...{{ end }}` |
 | `hasPrefix prefix text` | 判断前缀。 | `{{ hasPrefix "prod-" $name }}` |
 | `hasSuffix suffix text` | 判断后缀。 | `{{ hasSuffix ".log" $file }}` |
-| `regexMatch pattern text` | 正则匹配。 | `{{ regexMatch "error|failed" $msg }}` |
+| `regexMatch pattern text` | 正则匹配。 | `{{ regexMatch "error\|failed" $msg }}` |
 | `regexFind pattern text` | 返回第一个完整正则匹配。 | `{{ regexFind "trace_id=[a-z0-9]+" $msg }}` |
 | `regexFindAll pattern text n` | 返回最多 `n` 个完整正则匹配。`-1` 表示全部返回。 | `{{ regexFindAll "id=[0-9]+" $msg -1 }}` |
 | `regexReplaceAll pattern text repl` | 正则替换。参数顺序是 `pattern`、`text`、`replacement`。 | `{{ regexReplaceAll ".*id=([0-9]+).*" $msg "$1" }}` |