Browse Source

docs: EMQ X -> EMQX

Zaiming (Stone) Shi 4 years atrás
parent
commit
a5f6e94467

+ 5 - 5
CHANGES-4.3.md

@@ -1,6 +1,6 @@
-# EMQ X 4.3 Changes
+# EMQX 4.3 Changes
 
 
-Started tracking changes in CHANGE.md since EMQ X v4.3.11
+Started tracking changes in CHANGE.md since EMQX v4.3.11
 
 
 NOTE: Keep prepending to the head of the file instead of the tail
 NOTE: Keep prepending to the head of the file instead of the tail
 
 
@@ -53,9 +53,9 @@ Important notes:
 
 
 ### Important changes
 ### Important changes
 
 
-* Debian/Ubuntu package (deb) installed EMQ X now runs on systemd [#6389]<br>
+* Debian/Ubuntu package (deb) installed EMQX now runs on systemd [#6389]<br>
   This is to take advantage of systemd's supervision functionality to ensure
   This is to take advantage of systemd's supervision functionality to ensure
-  EMQ X service is restarted after crashes.
+  EMQX service is restarted after crashes.
 
 
 ### Minor changes
 ### Minor changes
 
 
@@ -71,7 +71,7 @@ Important notes:
 
 
 * Fix session takeover race condition which may lead to message loss [#6396]
 * Fix session takeover race condition which may lead to message loss [#6396]
 
 
-* EMQ X docker images are pushed to aws public ecr in an automated CI job [#6271]<br>
+* EMQX docker images are pushed to aws public ecr in an automated CI job [#6271]<br>
   `docker pull public.ecr.aws/emqx/emqx:4.3.10`
   `docker pull public.ecr.aws/emqx/emqx:4.3.10`
 
 
 * Fix webhook URL path to allow rule-engine variable substitution [#6399]
 * Fix webhook URL path to allow rule-engine variable substitution [#6399]

+ 8 - 8
Windows.md

@@ -1,4 +1,4 @@
-# Build and run EMQ X on Windows
+# Build and run EMQX on Windows
 
 
 NOTE: The instructions and examples are based on Windows 10.
 NOTE: The instructions and examples are based on Windows 10.
 
 
@@ -6,7 +6,7 @@ NOTE: The instructions and examples are based on Windows 10.
 
 
 ### Visual studio for C/C++ compile and link
 ### Visual studio for C/C++ compile and link
 
 
-EMQ X includes Erlang NIF (Native Implmented Function) components, implemented
+EMQX includes Erlang NIF (Native Implmented Function) components, implemented
 in C/C++. To compile and link C/C++ libraries, the easiest way is perhaps to
 in C/C++. To compile and link C/C++ libraries, the easiest way is perhaps to
 install Visual Studio.
 install Visual Studio.
 
 
@@ -51,7 +51,7 @@ Eshell V11.1.4  (abort with ^G)
 
 
 ### bash
 ### bash
 
 
-All EMQ X build/run scripts are either in `bash` or `escript`.
+All EMQX build/run scripts are either in `bash` or `escript`.
 `escript` is installed as a part of Erlang. To install a `bash`
 `escript` is installed as a part of Erlang. To install a `bash`
 environment in Windows, there are quite a few options.
 environment in Windows, there are quite a few options.
 
 
@@ -68,7 +68,7 @@ Cygwin is what we tested with.
 
 
 ### Other tools
 ### Other tools
 
 
-Some of the unix world tools are required to build EMQ X.  Including:
+Some of the unix world tools are required to build EMQX.  Including:
 
 
 * git
 * git
 * curl
 * curl
@@ -84,7 +84,7 @@ When using scoop:
 scoop install git curl make jq zip unzip
 scoop install git curl make jq zip unzip
 ```
 ```
 
 
-## Build EMQ X source code
+## Build EMQX source code
 
 
 * Clone the repo: `git clone https://github.com/emqx/emqx.git`
 * Clone the repo: `git clone https://github.com/emqx/emqx.git`
 
 
@@ -112,11 +112,11 @@ scoop install git curl make jq zip unzip
   To fix it, Visual Studio's bin paths should be ordered prior to Cygwin's (or similar installation's)
   To fix it, Visual Studio's bin paths should be ordered prior to Cygwin's (or similar installation's)
   bin paths in `Path` environment variable.
   bin paths in `Path` environment variable.
 
 
-## Run EMQ X
+## Run EMQX
 
 
-To start EMQ X broker.
+To start EMQX broker.
 
 
-Execute `_build\emqx\rel\emqx>.\bin\emqx console` or `_build\emqx\rel\emqx>.\bin\emqx start` to start EMQ X.
+Execute `_build\emqx\rel\emqx>.\bin\emqx console` or `_build\emqx\rel\emqx>.\bin\emqx start` to start EMQX.
 
 
 Then execute `_build\emqx\rel\emqx>.\bin\emqx_ctl status` to check status.
 Then execute `_build\emqx\rel\emqx>.\bin\emqx_ctl status` to check status.
 If everything works fine, it should print out
 If everything works fine, it should print out

+ 2 - 2
apps/emqx_exhook/docs/design-cn.md

@@ -2,7 +2,7 @@
 
 
 ## 动机
 ## 动机
 
 
-在 EMQ X Broker v4.1-v4.2 中,我们发布了 2 个插件来扩展 emqx 的编程能力:
+在 EMQX Broker v4.1-v4.2 中,我们发布了 2 个插件来扩展 emqx 的编程能力:
 
 
 1. `emqx-extension-hook` 提供了使用 Java, Python 向 Broker 挂载钩子的功能
 1. `emqx-extension-hook` 提供了使用 Java, Python 向 Broker 挂载钩子的功能
 2. `emqx-exproto` 提供了使用 Java,Python 编写用户自定义协议接入插件的功能
 2. `emqx-exproto` 提供了使用 Java,Python 编写用户自定义协议接入插件的功能
@@ -26,7 +26,7 @@
 架构如下:
 架构如下:
 
 
 ```
 ```
-  EMQ X                                    
+  EMQX
 +========================+                 +========+==========+
 +========================+                 +========+==========+
 |    ExHook              |                 |        |          |
 |    ExHook              |                 |        |          |
 |   +----------------+   |      gRPC       | gRPC   |  User's  |
 |   +----------------+   |      gRPC       | gRPC   |  User's  |

+ 4 - 4
apps/emqx_exproto/docs/design-cn.md

@@ -2,7 +2,7 @@
 
 
 `emqx-exproto` 插件用于协议解析的多语言支持。它能够允许其他编程语言(例如:Python,Java 等)直接处理数据流实现协议的解析,并提供 Pub/Sub 接口以实现与系统其它组件的通信。
 `emqx-exproto` 插件用于协议解析的多语言支持。它能够允许其他编程语言(例如:Python,Java 等)直接处理数据流实现协议的解析,并提供 Pub/Sub 接口以实现与系统其它组件的通信。
 
 
-该插件给 EMQ X 带来的扩展性十分的强大,它能以你熟悉语言处理任何的私有协议,并享受由 EMQ X 系统带来的高连接,和高并发的优点。
+该插件给 EMQX 带来的扩展性十分的强大,它能以你熟悉语言处理任何的私有协议,并享受由 EMQX 系统带来的高连接,和高并发的优点。
 
 
 ## 特性
 ## 特性
 
 
@@ -25,12 +25,12 @@
     - 提供 `Send` 接口。供外部模块调用,**用于发送数据包**。
     - 提供 `Send` 接口。供外部模块调用,**用于发送数据包**。
     - 提供 `Close` 接口。供外部模块调用,**用于主动关闭连接**。
     - 提供 `Close` 接口。供外部模块调用,**用于主动关闭连接**。
 
 
-2. **协议/会话层:**该部分主要**提供 PUB/SUB 接口**,以实现与 EMQ X Broker 系统的消息互通。包括:
+2. **协议/会话层:**该部分主要**提供 PUB/SUB 接口**,以实现与 EMQX Broker 系统的消息互通。包括:
 
 
     - 提供 `Authenticate` 接口。供外部模块调用,用于向集群注册客户端。
     - 提供 `Authenticate` 接口。供外部模块调用,用于向集群注册客户端。
     - 提供 `StartTimer` 接口。供外部模块调用,用于为该连接进程启动心跳等定时器。
     - 提供 `StartTimer` 接口。供外部模块调用,用于为该连接进程启动心跳等定时器。
-    - 提供 `Publish` 接口。供外部模块调用,用于发布消息 EMQ X Broker 中。
-    - 提供 `Subscribe` 接口。供外部模块调用,用于订阅某主题,以实现从 EMQ X Broker 中接收某些下行消息。
+    - 提供 `Publish` 接口。供外部模块调用,用于发布消息 EMQX Broker 中。
+    - 提供 `Subscribe` 接口。供外部模块调用,用于订阅某主题,以实现从 EMQX Broker 中接收某些下行消息。
     - 提供 `Unsubscribe` 接口。供外部模块调用,用于取消订阅某主题。
     - 提供 `Unsubscribe` 接口。供外部模块调用,用于取消订阅某主题。
     - 调用 `OnTimerTimeout` 回调。用于处理定时器超时的事件。
     - 调用 `OnTimerTimeout` 回调。用于处理定时器超时的事件。
     - 调用 `OnReceivedMessages` 回调。用于接收下行消息(在订阅主题成功后,如果主题上有消息,便会回调该方法)
     - 调用 `OnReceivedMessages` 回调。用于接收下行消息(在订阅主题成功后,如果主题上有消息,便会回调该方法)

+ 3 - 3
apps/emqx_rule_engine/docs/design.md

@@ -1,7 +1,7 @@
 
 
-# EMQ X Rule Engine
+# EMQX Rule Engine
 
 
-This is the design guide of message routing rule engine for the EMQ X Broker.
+This is the design guide of message routing rule engine for the EMQX Broker.
 
 
 ## Concept
 ## Concept
 
 
@@ -149,7 +149,7 @@ The properties and behaviors of resources is defined by resource types. A resour
 
 
 ### Resource Type Provider
 ### Resource Type Provider
 
 
-Provider of resource type is a EMQ X Plugin.
+Provider of resource type is a EMQX Plugin.
 
 
 ### Resource Manager
 ### Resource Manager