From ee122155f1ff280fdf63633af1873b5d1ef75137 Mon Sep 17 00:00:00 2001
From: "Zaiming (Stone) Shi" <zmstone@gmail.com>
Date: Fri, 26 May 2023 08:44:19 +0200
Subject: [PATCH] docs: fix spellcheck for telemetry app

---
 apps/emqx_telemetry/src/emqx_telemetry_schema.erl | 4 +++-
 rel/i18n/emqx_telemetry_schema.hocon              | 8 ++++++++
 rel/i18n/zh/emqx_telemetry_schema.hocon           | 8 ++++++++
 scripts/spellcheck/dicts/emqx.txt                 | 1 +
 scripts/spellcheck/spellcheck.sh                  | 2 +-
 5 files changed, 21 insertions(+), 2 deletions(-)
 create mode 100644 rel/i18n/emqx_telemetry_schema.hocon
 create mode 100644 rel/i18n/zh/emqx_telemetry_schema.hocon

diff --git a/apps/emqx_telemetry/src/emqx_telemetry_schema.erl b/apps/emqx_telemetry/src/emqx_telemetry_schema.erl
index 9f5f09836..56cbbfc04 100644
--- a/apps/emqx_telemetry/src/emqx_telemetry_schema.erl
+++ b/apps/emqx_telemetry/src/emqx_telemetry_schema.erl
@@ -30,7 +30,9 @@
 roots() -> ["telemetry"].
 
 fields("telemetry") ->
-    [{enable, ?HOCON(boolean(), #{default => true, desc => "Enable telemetry."})}].
+    [{enable, ?HOCON(boolean(), #{default => true, desc => ?DESC("enable")})}].
 
+desc("telemetry") ->
+    ?DESC("telemetry_root_doc");
 desc(_) ->
     undefined.
diff --git a/rel/i18n/emqx_telemetry_schema.hocon b/rel/i18n/emqx_telemetry_schema.hocon
new file mode 100644
index 000000000..b49a58a62
--- /dev/null
+++ b/rel/i18n/emqx_telemetry_schema.hocon
@@ -0,0 +1,8 @@
+emqx_telemetry_schema {
+telemetry_root_doc.desc:
+"""Configure telemetry data report from this EMQX node to EMQ's telemetry data collection server.
+See https://www.emqx.io/docs/en/v5.0/telemetry/telemetry.html for more details."""
+
+enable.desc:
+"""Set to `false` disable telemetry data report"""
+}
diff --git a/rel/i18n/zh/emqx_telemetry_schema.hocon b/rel/i18n/zh/emqx_telemetry_schema.hocon
new file mode 100644
index 000000000..0fa238ee1
--- /dev/null
+++ b/rel/i18n/zh/emqx_telemetry_schema.hocon
@@ -0,0 +1,8 @@
+emqx_telemetry_schema {
+telemetry_root_doc.desc:
+"""配置 EMQX 节点向EMQ 的遥测服务器发送要测数据。
+详情请参考 https://www.emqx.io/docs/zh/v5.0/telemetry/telemetry.html。"""
+
+enable.desc:
+"""设置为 `false` 可以关闭数据发送。"""
+}
diff --git a/scripts/spellcheck/dicts/emqx.txt b/scripts/spellcheck/dicts/emqx.txt
index bdbd77b3b..ea1c76d96 100644
--- a/scripts/spellcheck/dicts/emqx.txt
+++ b/scripts/spellcheck/dicts/emqx.txt
@@ -23,6 +23,7 @@ DevOps
 Dialyzer
 Diffie
 EIP
+EMQ
 EMQX
 EPMD
 ERL
diff --git a/scripts/spellcheck/spellcheck.sh b/scripts/spellcheck/spellcheck.sh
index a21fc93ec..57ea21c55 100755
--- a/scripts/spellcheck/spellcheck.sh
+++ b/scripts/spellcheck/spellcheck.sh
@@ -7,7 +7,7 @@ cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")/../.."
 PROJ_ROOT="$(pwd)"
 
 if [ -z "${1:-}" ]; then
-    SCHEMA="${PROJ_ROOT}/_build/emqx/lib/emqx_dashboard/priv/www/static/schema.json"
+    SCHEMA="${PROJ_ROOT}/_build/docgen/emqx/schema-en.json"
 else
     SCHEMA="$(realpath "$1")"
 fi