Skip to content

Commit 29a854a

Browse files
committed
fix: spelling errors detected by typos
1 parent 5b1c0af commit 29a854a

20 files changed

+53
-53
lines changed

_typos.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ Sur = "Sur"
4848
iif = "iif"
4949

5050
[files]
51-
extend-exclude = ["redocly", "cfg-manual-docgen"]
51+
extend-exclude = ["redocly", "cfg-manual-docgen", "hocon"]

dir.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# - A doc node may have edition: ee for enterprise only content
77
#
88
# Grouping node
9-
# - Must have a 'title_en' (English), 'title_cn' (Chinese), 'title_ja' (Japanese) is optional wehn no need to translate. e.g. FAQ
9+
# - Must have a 'title_en' (English), 'title_cn' (Chinese), 'title_ja' (Japanese) is optional when no need to translate. e.g. FAQ
1010
# - Parent nodes must NOT have a 'path'
1111
#
1212
# Content node can be one of:

en_US/changes/changes-ee-v5.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,7 @@ Make sure to check the breaking changes and known issues before upgrading to EMQ
572572

573573
- [#14192](https://github.com/emqx/emqx/pull/14192) Allowed will messages to be sent by the clients that disconnect because of authentication/authorization expiration. Previously, such clients could not send a will message because the sending occurred just after the authorization expiration, so the message could not pass the authorization rules.
574574

575-
- [#14122](https://github.com/emqx/emqx/pull/14122) Fixed handling of `PUBACK` and `PUBREC`/`PUBCOMP` when the published message has QoS 2 and 1, repectively.
575+
- [#14122](https://github.com/emqx/emqx/pull/14122) Fixed handling of `PUBACK` and `PUBREC`/`PUBCOMP` when the published message has QoS 2 and 1, respectively.
576576

577577
Prior to this fix, the broker would accept `PUBACK` and `PUBREC`/`PUBCOMP` packets from clients referencing packet identifiers that corresponded to messages with QoS 2 and 1, respectively. Now, the broker will disconnect clients that behave like this.
578578

@@ -603,7 +603,7 @@ Make sure to check the breaking changes and known issues before upgrading to EMQ
603603

604604
Note: while performing a rolling upgrade, this API may not list all existing clients until all nodes are migrated. As a workaround, if HTTP API requests are issued to old core nodes, all clients can be listed before all nodes are fully upgraded.
605605

606-
- [#14182](https://github.com/emqx/emqx/pull/14182) Previously, if a delayed message was published via the `POST /publish` HTTP API, a 202 reponse with the reason code 16 ("no matching subscribers") would be returned. Now, a 200 response is sent along with the message identifier.
606+
- [#14182](https://github.com/emqx/emqx/pull/14182) Previously, if a delayed message was published via the `POST /publish` HTTP API, a 202 response with the reason code 16 ("no matching subscribers") would be returned. Now, a 200 response is sent along with the message identifier.
607607

608608
#### MQTT Durable Sessions
609609

@@ -676,7 +676,7 @@ Make sure to check the breaking changes and known issues before upgrading to EMQ
676676

677677
Previously, upon (re)starting the Connector, it would perform one `ListStreams` request for each worker in its connection pool. Additionally, each periodic health check would do `ListStreams` for each worker. The Action health check would do `DescribeStream` for each connection worker in the pool.
678678

679-
Now, the Connector no longer performs the initial `ListStreams` upon (re)starting. Both Connector and Action attempt to check if at least one worker has a healthy response from their respective API requests: the request is attempted by each worker serially, and the Connector or Action is considered `connected` upon the first successful response received. Thus, in the best case scenario, each Connector and each Action will do 1 API request each per health check, regardless of pool sizea. In the worst case scenario, each worker in the pool might still perform one request each, if they fail to receive a sucessful response.
679+
Now, the Connector no longer performs the initial `ListStreams` upon (re)starting. Both Connector and Action attempt to check if at least one worker has a healthy response from their respective API requests: the request is attempted by each worker serially, and the Connector or Action is considered `connected` upon the first successful response received. Thus, in the best case scenario, each Connector and each Action will do 1 API request each per health check, regardless of pool sizea. In the worst case scenario, each worker in the pool might still perform one request each, if they fail to receive a successful response.
680680

681681
- [#14767](https://github.com/emqx/emqx/pull/14767) Kafka producer now smoothly handles Kafka topic re-creation with fewer partitions.
682682
Previously, the lost partition producers may linger behind to retry and write large amount of error logs.
@@ -696,15 +696,15 @@ Make sure to check the breaking changes and known issues before upgrading to EMQ
696696

697697
- [#15087](https://github.com/emqx/emqx/pull/15087) Fixed an issue with `hocon` library in which, if one had any string one-liner field that ended in a lone backslash, the configuration file would fail to be parsed later.
698698

699-
#### Plugin and Extention
699+
#### Plugin and Extension
700700

701701
- [#15073](https://github.com/emqx/emqx/pull/15073) Added a validator for the server URL in the `exhook` configuration. This ensures that only valid URLs can be saved. Invalid URLs will now trigger an error and prevent being saved, which helps avoid issues during the import process, where previously invalid URLs could be accepted.
702702

703703
- [#14774](https://github.com/emqx/emqx/pull/14774) Resolved plugin related issues. Fixed a retrieval issue with the plugin configuration file from cluster nodes when initiating the plugin without an existing configuration file.
704704

705705
- [#14826](https://github.com/emqx/emqx/pull/14826) Fixed the issue where the Exhook server's return of "IGNORE" was not taking effect.
706706

707-
- [#15018](https://github.com/emqx/emqx/pull/15018) Fixed a bug with Exhook in which attemtping to import an invalid `exhook` configuration via the CLI would result in a crash with a `badarg` error.
707+
- [#15018](https://github.com/emqx/emqx/pull/15018) Fixed a bug with Exhook in which attempting to import an invalid `exhook` configuration via the CLI would result in a crash with a `badarg` error.
708708

709709
- [#15108](https://github.com/emqx/emqx/pull/15108) ExHook now includes a built-in gRPC health check mechanism, ensuring that the connection status accurately reflects the actual availability of the external hook server.
710710

en_US/deploy/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,15 +142,15 @@ The table below introduces the files and subfolders of some directories.
142142
| Directory | Description | Permissions | Files |
143143
| --------- | ------------------- | ----------- | ------------------------------------------------------------ |
144144
| bin | Executables | Read | `emqx` and `emqx.cmd`: Executables of EMQX. For details, see [Command Line Interface](../admin/cli.md). |
145-
| etc | Configuration files | Read | `base.hocon`: Base configuration which can be overriden from runtime config changes.<br /><br />`emqx.conf`: Static configurations which cannot be overridden.<br /><br />`emqx-example-en.conf`: Demo configuration files of EMQX, contains all the configurable items.<br /><br />`acl.conf`: Default ACl rules.<br /><br />`vm.args`: Operating parameters of the Erlang virtual machine.<br /><br />`certs/`: X.509 keys and certificate files for EMQX SSL listeners, may also be used in the SSL/TLS connection when integrating with external systems. |
145+
| etc | Configuration files | Read | `base.hocon`: Base configuration which can be overridden from runtime config changes.<br /><br />`emqx.conf`: Static configurations which cannot be overridden.<br /><br />`emqx-example-en.conf`: Demo configuration files of EMQX, contains all the configurable items.<br /><br />`acl.conf`: Default ACl rules.<br /><br />`vm.args`: Operating parameters of the Erlang virtual machine.<br /><br />`certs/`: X.509 keys and certificate files for EMQX SSL listeners, may also be used in the SSL/TLS connection when integrating with external systems. |
146146
| data | Operating data | Write | `authz`: Stores file authorization rules uploaded by REST API or Dashboard. For details, see [Authorization - File](../access-control/authz/file.md). <br /><br />`certs`: Stores certificate files uploaded by REST API or Dashboard.<br /><br />`configs`: Stores configuration files generated at boot, or configuration overrides by changes from API or CLI.<br /><br />`mnesia`: Built-in database to store EMQX operating data, including alarm records, authentication and authorization data of the clients, Dashboard user information, etc. **If the directory is deleted, all these operating data will be lost.**<br /><br /> — May contain subdirectories named after different node, e.g., `[email protected]`. Note: In case of node renaming, you should also delete or remove the corresponding subdirectory. <br /><br /> — Can use command `emqx ctl mnesia` to query the built-in database. For details, see [Management Command CLI](https://docs.emqx.com/en/enterprise/v5.0/admin/cli.html).<br /><br />`patches`: Stores the `.beam` files for EMQX to load as a hot patch. Can be used for a quick fix.<br /><br />`trace`: Online tracing log files.<br /><br />In production, it is recommended to periodically backup the `data` directory (excluding the `trace` folder ) for data safety. |
147147
| log | Operating logs | Read | `emqx.log.*`: Operation logs of EMQX, for more information, see [logs](../observability/log.md). |
148148

149149
:::tip
150150

151151
EMQX stores the configuration information in the `data/configs` and the `etc` directory. The `etc` directory stores read-only configuration files, while configuration updates from the Dashboard or REST API are saved in the `data/configs` directory to support hot configuration reloads at runtime.
152152

153-
- `etc/base.hocon`: Base configuration which can be overriden from runtime config changes.
153+
- `etc/base.hocon`: Base configuration which can be overridden from runtime config changes.
154154
- `etc/emqx.conf`: Static configuration which cannot be overridden.
155155
- `data/configs/cluster.hocon`: Runtime configuration overrides.
156156

0 commit comments

Comments
 (0)