Просмотр исходного кода

docs: fix spellcheck for telemetry app

Zaiming (Stone) Shi 2 лет назад
Родитель
Сommit
ee122155f1

+ 3 - 1
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.

+ 8 - 0
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"""
+}

+ 8 - 0
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` 可以关闭数据发送。"""
+}

+ 1 - 0
scripts/spellcheck/dicts/emqx.txt

@@ -23,6 +23,7 @@ DevOps
 Dialyzer
 Diffie
 EIP
+EMQ
 EMQX
 EPMD
 ERL

+ 1 - 1
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