fix(typos): Auto fix typos in 5.8 docs

Author: Meggielqk

DOCS-WRITING-GUIDE-EN.md

@@ -239,7 +239,7 @@ The configuration docs are generated from source code.
 Steps to  update:
 
 1. Re-build EMQX (opensource and enterprise edition)
-1. Copy the gnerated `md` files to this repo (see commands below)
+1. Copy the generated `md` files to this repo (see commands below)
 1. Rename the heading-1 of each file
     - Configuration Files (for en_US/admin/cfg-*.md)
     - 配置文件 (in zh_CN/admin/cfg-*.md)

_typos.toml

@@ -0,0 +1,50 @@
+[default]
+extend-ignore-re = [
+  "[A-Fa-f0-9]{8,}",                # hexadecimal tokens
+  "[A-Za-z0-9+/=]{12,}",           # base64-like random blobs
+  "([A-Z0-9]{2,}-){2,}[A-Z0-9]+",  # cipher suites (PSK-3DES-EDE-CBC-SHA)
+  "([A-Za-z]{2,}_){1,}[A-Za-z]+"   # snake_case config fields (may contain abbreviations)
+]
+
+[default.extend-words]
+# EMQX specific terms
+emqx = "emqx"
+kuiper = "kuiper"
+neuron = "neuron"
+mqtt = "mqtt"
+suback = "suback"
+puback = "puback"
+qos = "qos"
+mosquitto = "mosquitto"
+alis = "alis"
+wxs = "wxs" 
+
+# Technical jargon
+k8s = "k8s"
+auth = "auth"
+repo = "repo"
+schemas = "schemas"
+
+# Ordinal numbers
+1st = "1st"
+2nd = "2nd"
+3rd = "3rd"
+
+# Words that appeared in false positives
+succee = "succee"
+smal = "smal"
+siz = "siz"
+iif = "iif"
+EACG = "EACG"
+EDE = "EDE"
+HPE = "HPE"
+AKS = "AKS"
+aks = "aks"
+TKE = "TKE"
+Sur = "Sur"
+
+[default.extend-identifiers]
+iif = "iif"
+
+[files]
+extend-exclude = ["redocly", "cfg-manual-docgen"]

dir.yaml

@@ -6,7 +6,7 @@
 # - A doc node may have edition: ee for enterprise only content
 #
 # Grouping node
-# - Must have a 'title_en' (English), 'title_cn' (Chinese) is optional wehn no need to translate. e.g. FAQ
+# - Must have a 'title_en' (English), 'title_cn' (Chinese) is optional when no need to translate. e.g. FAQ
 # - Parent nodes must NOT have a 'path'
 #
 # Content node can be one of:

en_US/access-control/authz/file.md

@@ -103,7 +103,7 @@ Where,
 
 - `type`: Data source types of authorizer; here is `file`.
 - `enable`: Whether to activate the authorizer; optional value: `true`, `false`.
-- `path`: Configuration file path; default value: `etc/acl.conf`. If file-based authorizer is editted through Dashboard or REST API, EMQX stores the new file to `data/authz/acl.conf` and stops reading the configuration in the original file.
+- `path`: Configuration file path; default value: `etc/acl.conf`. If file-based authorizer is edited through Dashboard or REST API, EMQX stores the new file to `data/authz/acl.conf` and stops reading the configuration in the original file.
 
 <!--For detailed parameter list, see [authz-file](../../configuration/configuration-manual.html#authz-file). Need to update the link later-->
 

en_US/admin/cli.md

@@ -365,7 +365,7 @@ emqx_a -> topic:t/1 qos:0 nl:0 rh:0 rap:0
 
 ### subscriptions add \<ClientId\> \<Topic\> \<QoS\>
 
-Mannually add a subscription.
+Manually add a subscription.
 
 ```bash
 $ emqx ctl subscriptions add emqx_a t/1 1
@@ -1528,7 +1528,7 @@ Currently there are by default 5 registered gateways:
 * mqttsn
 * stomp
 
-EMQX is designed to be plugable, so that more gateways can be installed as pluginsand register to EMQX at runtime.
+EMQX is designed to be pluggable, so that more gateways can be installed as pluginsand register to EMQX at runtime.
 Once registered, a gateway can be managed with management APIs and CLIs (see `gateway` command below).
 
 ## gateway-clients

en_US/changes/auth-4.4-to-5.1-compatibility.md

@@ -394,7 +394,7 @@ backend = mongodb
 
 - `srv_record`, `username`, `password`, `auth_source`, `database`, `w_mode`, `topology`, `collection` are retained.
 
-- `r_mode` is availalable only for `rs` type.
+- `r_mode` is available only for `rs` type.
 
 - `pool` is changed to `pool_size`.
 
@@ -1156,7 +1156,7 @@ type = mongodb
   - For `rs`, `sharded` to `servers`
   - For `single` to `server`
 - `srv_record`, `username`, `password`, `auth_source`, `database`, `w_mode`, `topology`, `collection` are retained.
-- `r_mode` is availalable only for `rs` type.
+- `r_mode` is available only for `rs` type.
 - `pool` is changed to `pool_size`.
 - `ssl.*` is changed to common SSL options. Refer to [TLS for External Resource Access](../network/overview.md#tls-for-external-resource-access).
 - `auth_query.selector` is changed to `filter`. The filter should not be a string, but the whole selector data structure.  `${var`}-style [placeholders](../access-control/authn/authn.md#authentication-placeholders) may be used in selector values.

en_US/changes/breaking-changes-5.1.0.md

@@ -153,7 +153,7 @@ The previous official plugins have been migrated to EMQX as built-in functions.
 | emqx_bridge_mqtt | Data Bridge - MQTT Bridge                                 |
 | emqx_web_hook    | Data Bridge - HTTP Server                                 |
 | emqx_coap        | CoAP Gateway                                              |
-| emqx_dashboard   | Dasboard                                                  |
+| emqx_dashboard   | Dashboard                                                  |
 | emqx_exhook      | ExHook                                                    |
 | emqx_exproto     | ExProto Gateway                                           |
 | emqx_lwm2m       | LwM2M Gateway                                             |

en_US/changes/breaking-changes-ce-5.4.md

@@ -4,7 +4,7 @@
 
 - [#11994](https://github.com/emqx/emqx/pull/11994) Stopped releasing packages for Windows.
 
-- [#11998](https://github.com/emqx/emqx/pull/11998) Stopped releasing packages for MacOS 11 (BigSur).
+- [#11998](https://github.com/emqx/emqx/pull/11998) Stopped releasing packages for MacOS 11 (Big Sur).
 
 - [#12112](https://github.com/emqx/emqx/pull/12112) Stopped supporting UDP multicast based clustering strategy.
 

en_US/changes/breaking-changes-ce-5.8.md

@@ -24,7 +24,7 @@
 
 ## v5.8.1
 
-- [#13792](https://github.com/emqx/emqx/pull/13792) The default expiration time for a banned item that is created without an `until` value is now `infinity` (previsouly capped at 1 year limit).
+- [#13792](https://github.com/emqx/emqx/pull/13792) The default expiration time for a banned item that is created without an `until` value is now `infinity` (previously capped at 1 year limit).
 
 - [#13742](https://github.com/emqx/emqx/pull/13742) Fixed an issue when a client would receive retained messages for a topic starting with `$` when it subscribed to topic `#` or `+`.
 

en_US/changes/breaking-changes-ee-5.4.md

@@ -2,7 +2,7 @@
 
 ## e5.4.0
 
-- [#11998](https://github.com/emqx/emqx/pull/11998) Stopped releasing packages for MacOS 11 (BigSur).
+- [#11998](https://github.com/emqx/emqx/pull/11998) Stopped releasing packages for MacOS 11 (Big Sur).
 
 - [#12112](https://github.com/emqx/emqx/pull/12112) Stopped supporting UDP multicast based clustering strategy.