From 3d07ddd4f0b2e9dd237706d8e4d04e5d0c31e726 Mon Sep 17 00:00:00 2001
From: JianBo He <heeejianbo@gmail.com>
Date: Tue, 18 Jul 2023 15:23:37 +0800
Subject: [PATCH] chore: improve the `sys_msg_interval` config docs

---
 rel/i18n/emqx_schema.hocon | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/rel/i18n/emqx_schema.hocon b/rel/i18n/emqx_schema.hocon
index f871cfc49..3ecb930cd 100644
--- a/rel/i18n/emqx_schema.hocon
+++ b/rel/i18n/emqx_schema.hocon
@@ -697,7 +697,12 @@ fields_mqtt_quic_listener_minimum_mtu.label:
 """Minimum MTU"""
 
 sys_msg_interval.desc:
-"""Time interval of publishing `$SYS` messages."""
+"""Time interval for publishing following system messages:
+  - `$SYS/brokers`
+  - `$SYS/brokers/<node>/version`
+  - `$SYS/brokers/<node>/sysdescr`
+  - `$SYS/brokers/<node>/stats/<name>`
+  - `$SYS/brokers/<node>/metrics/<name>`"""
 
 mqtt_await_rel_timeout.desc:
 """For client to broker QoS 2 message, the time limit for the broker to wait before the `PUBREL` message is received. The wait is aborted after timed out, meaning the packet ID is freed for new `PUBLISH` requests. Receiving a stale `PUBREL` causes a warning level log. Note, the message is delivered to subscribers before entering the wait for PUBREL."""