Browse Source

docs: fix severl doc issue (#531)

* docs: fix severl doc issue

* Update README-CN.md

Co-authored-by: Rory Z <Rory-Z@outlook.com>

* Update README.md

Co-authored-by: Rory Z <Rory-Z@outlook.com>

Co-authored-by: Rory Z <Rory-Z@outlook.com>
jinfahua 4 năm trước cách đây
mục cha
commit
1fa150baff
5 tập tin đã thay đổi với 32 bổ sung28 xóa
  1. 3 4
      README-CN.md
  2. 3 3
      README.md
  3. 18 17
      deploy/docker/README.md
  4. 4 2
      docs/en_US/quick_start_docker.md
  5. 4 2
      docs/zh_CN/quick_start_docker.md

+ 3 - 4
README-CN.md

@@ -40,13 +40,13 @@ Kuiper 可以运行在各类物联网的边缘使用场景中,比如工业物
   - SQL 函数:内置支持60+常见的函数,提供扩展点可以扩展自定义函数
 
 - 管理能力
-  - 通过命令行对流、规则和插件进行管理
-  - 通过 REST API 也可以对流、规则和插件进行管理
+  - [基于 Web 的管理控制台](https://hub.docker.com/r/emqx/kuiper-manager),用于节点,插件,流和规则的管理
+  - 通过命令行和 REST API 对流、规则和插件进行管理
   - 与 [KubeEdge](https://github.com/kubeedge/kubeedge)、[K3s](https://github.com/rancher/k3s)、[Baetyl](https://github.com/baetyl/baetyl) 等基于边缘 Kubernetes 框架的集成能力
 
 - 与 EMQ X Edge 集成
 
-  提供了与 EMQ X Edge 的无缝集成,实现在边缘端从消息接入到数据分析端到端的场景实现能力
+  提供了与 EMQ X Neuron 和 EMQ X Edge 的无缝集成,实现在边缘端从消息接入到数据分析端到端的场景实现能力
 
 ## 快速入门
 
@@ -149,4 +149,3 @@ Kuiper 可以运行在各类物联网的边缘使用场景中,比如工业物
 ## 开源版权
 
 [Apache 2.0](LICENSE)
-

+ 3 - 3
README.md

@@ -41,13 +41,13 @@ It can be run at various IoT edge use scenarios, such as real-time processing of
 
 - Management
 
-  - Stream and rule management through CLI
-  - Stream and rule management through REST API
+  - [A web based management dashboard](https://hub.docker.com/r/emqx/kuiper-manager) for nodes, plugins, streams & rules management
+  - Plugins, streams and rules management through CLI & REST API
   - Easily be integrate with [KubeEdge](https://github.com/kubeedge/kubeedge), [K3s](https://github.com/rancher/k3s) and [Baetyl](https://github.com/baetyl/baetyl), which bases Kubernetes
 
 - Integration with EMQ X Edge
 
-  Seamless integration with EMQ X Edge, and provided an end to end solution from messaging to analytics. 
+  Seamless integration with EMQ X Neuron & EMQ X Edge, and provided an end to end solution from messaging to analytics. 
 
 ## Quick start
 

Những thai đổi đã bị hủy bỏ vì nó quá lớn
+ 18 - 17
deploy/docker/README.md


Những thai đổi đã bị hủy bỏ vì nó quá lớn
+ 4 - 2
docs/en_US/quick_start_docker.md


+ 4 - 2
docs/zh_CN/quick_start_docker.md

@@ -5,7 +5,7 @@
 2. 设置 Kuiper 源为一个 MQTT 服务器。本例使用位于 `tcp://broker.emqx.io:1883` 的 MQTT 服务器, `broker.emqx.io` 是一个由 [EMQ](https://www.emqx.io) 提供的公有 MQTT 服务器。
 
    ```shell
-   docker run -d --name kuiper -e MQTT_BROKER_ADDRESS=tcp://broker.emqx.io:1883 emqx/kuiper:$tag
+   docker run -p 9081:9081 -d --name kuiper -e MQTT_SOURCE__DEFAULT__SERVERS=[tcp://broker.emqx.io:1883] emqx/kuiper:$tag
    ```
 
 3. 创建流(stream)- 流式数据的结构定义,类似于数据库中的表格类型定义。比如说要发送温度与湿度的数据到 `broker.emqx.io`,这些数据将会被在**本地运行的** Kuiper docker 实例中处理。以下的步骤将创建一个名字为 `demo` 的流,并且数据将会被发送至 `devices/device_001/messages` 主题,这里的 `device_001` 可以是别的设备,比如 `device_002`,所有的这些数据会被 `demo` 流订阅并处理。
@@ -43,7 +43,9 @@
 
 6. 如果想停止测试,在`bin/cli query`命令行窗口中敲 `ctrl + c ` ,或者输入 `exit` 后回车
 
-7. 想了解更多 EMQ X Kuiper 的功能?请参考以下关于在边缘端使用 EMQ X Kuiper 与 AWS/Azure IoT 云集成的案例。
+你可以参考 [Kuiper 管理控制台](https://github.com/emqx/kuiper/blob/master/docs/zh_CN/manager-ui/overview.md) 这篇文章来了解更好的产品使用体验。
+
+想了解更多 EMQ X Kuiper 的功能?请参考以下关于在边缘端使用 EMQ X Kuiper 与 AWS/Azure IoT 云集成的案例。
 
    - [轻量级边缘计算 EMQ X Kuiper 与 AWS IoT 集成方案](https://www.jianshu.com/p/7c0218fd1ee2)
    - [轻量级边缘计算 EMQ X Kuiper 与 Azure IoT Hub 集成方案](https://www.jianshu.com/p/49b06751355f)