From 1be3eb1446591e8ca8dd4263b02570cd06ccc635 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Sat, 19 Feb 2022 12:47:17 +0100 Subject: [PATCH] chore: rename EMQX Broker to just EMQX --- README-CN.md | 2 +- README-JP.md | 2 +- README.md | 2 +- apps/emqx_dashboard/README.md | 2 +- apps/emqx_exhook/docs/design-cn.md | 2 +- apps/emqx_gateway/README.md | 2 +- apps/emqx_gateway/src/coap/README.md | 2 +- apps/emqx_gateway/src/emqx_gateway_api_clients.erl | 2 +- apps/emqx_gateway/src/exproto/README.md | 2 +- apps/emqx_gateway/src/lwm2m/README.md | 2 +- apps/emqx_management/src/emqx_mgmt_api_clients.erl | 3 +-- apps/emqx_management/src/emqx_mgmt_api_metrics.erl | 12 ++++++------ apps/emqx_rule_engine/README.md | 2 +- 13 files changed, 18 insertions(+), 19 deletions(-) diff --git a/README-CN.md b/README-CN.md index 5707df26f..11e15de29 100644 --- a/README-CN.md +++ b/README-CN.md @@ -1,4 +1,4 @@ -# EMQX Broker +# EMQX [![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen&label=Release)](https://github.com/emqx/emqx/releases) [![Build Status](https://img.shields.io/travis/emqx/emqx?label=Build)](https://travis-ci.org/emqx/emqx) diff --git a/README-JP.md b/README-JP.md index 67c02ad31..eb6e7567d 100644 --- a/README-JP.md +++ b/README-JP.md @@ -1,4 +1,4 @@ -# EMQX Broker +# EMQX [![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen&label=Release)](https://github.com/emqx/emqx/releases) [![Build Status](https://img.shields.io/travis/emqx/emqx?label=Build)](https://travis-ci.org/emqx/emqx) diff --git a/README.md b/README.md index 107c4252f..46716fa16 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# EMQX Broker +# EMQX [![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen&label=Release)](https://github.com/emqx/emqx/releases) [![Build Status](https://img.shields.io/travis/emqx/emqx?label=Build)](https://travis-ci.org/emqx/emqx) diff --git a/apps/emqx_dashboard/README.md b/apps/emqx_dashboard/README.md index 3ba15b982..96c607a50 100644 --- a/apps/emqx_dashboard/README.md +++ b/apps/emqx_dashboard/README.md @@ -2,7 +2,7 @@ emqx-dashboard ============== -Dashboard for the EMQX Broker. +EMQX Dashboard REST API -------- diff --git a/apps/emqx_exhook/docs/design-cn.md b/apps/emqx_exhook/docs/design-cn.md index dcc2cf946..7ab870cd3 100644 --- a/apps/emqx_exhook/docs/design-cn.md +++ b/apps/emqx_exhook/docs/design-cn.md @@ -2,7 +2,7 @@ ## 动机 -在 EMQX Broker v4.1-v4.2 中，我们发布了 2 个插件来扩展 emqx 的编程能力： +在 EMQX v4.1-v4.2 中，我们发布了 2 个插件来扩展 emqx 的编程能力： 1. `emqx-extension-hook` 提供了使用 Java, Python 向 Broker 挂载钩子的功能 2. `emqx-exproto` 提供了使用 Java，Python 编写用户自定义协议接入插件的功能 diff --git a/apps/emqx_gateway/README.md b/apps/emqx_gateway/README.md index 15b043311..be8f6cb35 100644 --- a/apps/emqx_gateway/README.md +++ b/apps/emqx_gateway/README.md @@ -1,6 +1,6 @@ # emqx_gateway -***This is a very early prototype application*** for Gateway in EMQX Broker 5.0 +EMQX Gateway ## Concept diff --git a/apps/emqx_gateway/src/coap/README.md b/apps/emqx_gateway/src/coap/README.md index 7d1c67f2e..045db529d 100644 --- a/apps/emqx_gateway/src/coap/README.md +++ b/apps/emqx_gateway/src/coap/README.md @@ -17,7 +17,7 @@ # EMQX 5.0 CoAP Gateway -emqx-coap is a CoAP Gateway for EMQX Broker. It translates CoAP messages into MQTT messages and make it possible to communiate between CoAP clients and MQTT clients. +emqx-coap is a CoAP Gateway for EMQX. It translates CoAP messages into MQTT messages and make it possible to communiate between CoAP clients and MQTT clients. diff --git a/apps/emqx_gateway/src/emqx_gateway_api_clients.erl b/apps/emqx_gateway/src/emqx_gateway_api_clients.erl index 46022c897..22c3dee37 100644 --- a/apps/emqx_gateway/src/emqx_gateway_api_clients.erl +++ b/apps/emqx_gateway/src/emqx_gateway_api_clients.erl @@ -739,7 +739,7 @@ common_client_props() -> "packet">>})} , {recv_oct, mk(integer(), - #{ desc => <<"Number of bytes received by EMQX Broker">>})} + #{ desc => <<"Number of bytes received">>})} , {recv_cnt, mk(integer(), #{ desc => <<"Number of socket packets received">>})} diff --git a/apps/emqx_gateway/src/exproto/README.md b/apps/emqx_gateway/src/exproto/README.md index 141a0f475..a2268f0dc 100644 --- a/apps/emqx_gateway/src/exproto/README.md +++ b/apps/emqx_gateway/src/exproto/README.md @@ -1,6 +1,6 @@ # emqx-exproto -The `emqx_exproto` extremely enhance the extensibility for EMQX. It allow using an others programming language to **replace the protocol handling layer in EMQX Broker**. +The `emqx_exproto` extremely enhance the extensibility for EMQX. It allow using an others programming language to **replace the protocol handling layer in EMQX**. ## Feature diff --git a/apps/emqx_gateway/src/lwm2m/README.md b/apps/emqx_gateway/src/lwm2m/README.md index cfaee3d8d..bf7626c6f 100644 --- a/apps/emqx_gateway/src/lwm2m/README.md +++ b/apps/emqx_gateway/src/lwm2m/README.md @@ -1,5 +1,5 @@ -# LwM2M Gateway for the EMQX Broker. +# LwM2M Gateway [The LwM2M Specifications](http://www.openmobilealliance.org/release/LightweightM2M) is a Lightweight Machine to Machine protocol. diff --git a/apps/emqx_management/src/emqx_mgmt_api_clients.erl b/apps/emqx_management/src/emqx_mgmt_api_clients.erl index a4fcd08a0..3218d707e 100644 --- a/apps/emqx_management/src/emqx_mgmt_api_clients.erl +++ b/apps/emqx_management/src/emqx_mgmt_api_clients.erl @@ -323,8 +323,7 @@ fields(client) -> <<"Number of PUBLISH QoS1 packets received">>})}, {'recv_msg.qos2', hoconsc:mk(integer(), #{desc => <<"Number of PUBLISH QoS2 packets received">>})}, - {recv_oct, hoconsc:mk(integer(), #{desc => - <<"Number of bytes received by EMQX Broker (the same below)">>})}, + {recv_oct, hoconsc:mk(integer(), #{desc => <<"Number of bytes received">>})}, {recv_pkt, hoconsc:mk(integer(), #{desc => <<"Number of MQTT packets received">>})}, {reductions, hoconsc:mk(integer(), #{desc => <<"Erlang reduction">>})}, {send_cnt, hoconsc:mk(integer(), #{desc => <<"Number of TCP packets sent">>})}, diff --git a/apps/emqx_management/src/emqx_mgmt_api_metrics.erl b/apps/emqx_management/src/emqx_mgmt_api_metrics.erl index c98f9a19e..e910b5ced 100644 --- a/apps/emqx_management/src/emqx_mgmt_api_metrics.erl +++ b/apps/emqx_management/src/emqx_mgmt_api_metrics.erl @@ -48,8 +48,8 @@ properties() -> [ {'actions.failure', integer, <<"Number of failure executions of the rule engine action">>}, {'actions.success', integer, <<"Number of successful executions of the rule engine action">>}, - {'bytes.received', integer, <<"Number of bytes received by EMQX Broker">>}, - {'bytes.sent', integer, <<"Number of bytes sent by EMQX Broker on this connection">>}, + {'bytes.received', integer, <<"Number of bytes received ">>}, + {'bytes.sent', integer, <<"Number of bytes sent on this connection">>}, {'client.auth.anonymous', integer, <<"Number of clients who log in anonymously">>}, {'client.authenticate', integer, <<"Number of client authentications">>}, {'client.check_authz', integer, <<"Number of Authorization rule checks">>}, @@ -66,9 +66,9 @@ properties() -> {'delivery.dropped.queue_full', integer, <<"Number of messages with a non-zero QoS that were dropped because the message queue was full when sending">>}, {'delivery.dropped.too_large', integer, <<"The number of messages that were dropped because the length exceeded the limit when sending">>}, {'messages.acked', integer, <<"Number of received PUBACK and PUBREC packet">>}, - {'messages.delayed', integer, <<"Number of delay- published messages stored by EMQX Broker">>}, - {'messages.delivered', integer, <<"Number of messages forwarded to the subscription process internally by EMQX Broker">>}, - {'messages.dropped', integer, <<"Total number of messages dropped by EMQX Broker before forwarding to the subscription process">>}, + {'messages.delayed', integer, <<"Number of delay-published messages">>}, + {'messages.delivered', integer, <<"Number of messages forwarded to the subscription process internally">>}, + {'messages.dropped', integer, <<"Total number of messages dropped before forwarding to the subscription process">>}, {'messages.dropped.await_pubrel_timeout', integer, <<"Number of messages dropped due to waiting PUBREL timeout">>}, {'messages.dropped.no_subscribers', integer, <<"Number of messages dropped due to no subscribers">>}, {'messages.forward', integer, <<"Number of messages forwarded to other nodes">>}, @@ -80,7 +80,7 @@ properties() -> {'messages.qos2.received', integer, <<"Number of QoS 2 messages received from clients">>}, {'messages.qos2.sent', integer, <<"Number of QoS 2 messages sent to clients">>}, {'messages.received', integer, <<"Number of messages received from the client, equal to the sum of messages.qos0.received\fmessages.qos1.received and messages.qos2.received">>}, - {'messages.retained', integer, <<"Number of retained messages stored by EMQX Broker">>}, + {'messages.retained', integer, <<"Number of retained messages">>}, {'messages.sent', integer, <<"Number of messages sent to the client, equal to the sum of messages.qos0.sent\fmessages.qos1.sent and messages.qos2.sent">>}, {'packets.auth.received', integer, <<"Number of received AUTH packet">>}, {'packets.auth.sent', integer, <<"Number of sent AUTH packet">>}, diff --git a/apps/emqx_rule_engine/README.md b/apps/emqx_rule_engine/README.md index 91e156574..2485ff534 100644 --- a/apps/emqx_rule_engine/README.md +++ b/apps/emqx_rule_engine/README.md @@ -1,7 +1,7 @@ # emqx-rule-engine -IoT Rule Engine for EMQX Broker. +IoT Rule Engine ## Concept