Skip to content

Commit

Permalink
fix(docs): clean up docs (#1155)
Browse files Browse the repository at this point in the history
Signed-off-by: Jianxiang Ran <rxan_embedded@163.com>
  • Loading branch information
superrxan authored Jan 17, 2022
1 parent 45bbea6 commit d7457bc
Show file tree
Hide file tree
Showing 135 changed files with 651 additions and 526 deletions.
10 changes: 5 additions & 5 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

LF Edge eKuiper 是 Golang 实现的轻量级物联网边缘分析、流式处理开源软件,可以运行在各类资源受限的边缘设备上。eKuiper 设计的一个主要目标就是将在云端运行的实时流式计算框架(比如 [Apache Spark](https://spark.apache.org)[Apache Storm](https://storm.apache.org)[Apache Flink](https://flink.apache.org) 等)迁移到边缘端。eKuiper 参考了上述云端流式处理项目的架构与实现,结合边缘流式数据处理的特点,采用了编写基于``源 (Source)````SQL (业务逻辑处理)``, ``目标 (Sink)`` 的规则引擎来实现边缘端的流式数据处理。

![arch](./docs/zh_CN/arch.png)
![arch](docs/zh_CN/resources/arch.png)

**应用场景**

Expand Down Expand Up @@ -90,7 +90,7 @@ eKuiper 可以运行在各类物联网的边缘使用场景中,比如工业物

- 使用 JMeter MQTT 插件来发送数据到 EMQ X 服务器,消息类似于 ``{"temperature": 10, "humidity" : 90}``, 温度与湿度的值是介于 0 ~ 100 之间的随机整数值
- eKuiper 从 EMQ X 服务器订阅消息,并且通过 SQL 分析数据: ``SELECT * FROM demo WHERE temperature > 50 ``
- 分析结果通过 [文件插件](docs/zh_CN/plugins/sinks/file.md) 写到本地的文件系统里
- 分析结果通过 [文件插件](docs/zh_CN/extension/native/sinks/file.md) 写到本地的文件系统里

| 设备 | 每秒发送消息数 | CPU 使用 | 内存 |
| ---------------------------------------------------- | -------------- | --------------- | ---- |
Expand Down Expand Up @@ -141,11 +141,11 @@ eKuiper 可以运行在各类物联网的边缘使用场景中,比如工业物

- [参考指南](docs/zh_CN/reference.md)
- [安装与操作](docs/zh_CN/operation/overview.md)
- [命令行界面工具-CLI](docs/zh_CN/cli/overview.md)
- [命令行界面工具-CLI](docs/zh_CN/operation/cli/overview.md)
- [eKuiper SQL参考](docs/zh_CN/sqls/overview.md)
- [规则](docs/zh_CN/rules/overview.md)
- [扩展eKuiper](docs/zh_CN/extension/overview.md)
- [插件](docs/zh_CN/plugins/overview.md)
- [插件](docs/zh_CN/extension/native/develop/overview.md)

## 视频教程

Expand Down Expand Up @@ -178,7 +178,7 @@ eKuiper 可以运行在各类物联网的边缘使用场景中,比如工业物
> Docker 镜像默认支持 EdgeX

项目版本页面里提供了预编译的二进制文件。如果您的操作系统或架构没有预编译的文件,请使用交叉编译自行构建,请参考[此文档](docs/zh_CN/cross-compile.md)
项目版本页面里提供了预编译的二进制文件。如果您的操作系统或架构没有预编译的文件,请使用交叉编译自行构建,请参考[此文档](docs/zh_CN/operation/compile/cross-compile.md)

## 开源版权

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

LF Edge eKuiper is an edge lightweight IoT data analytics / streaming software implemented by Golang, and it can be run at all kinds of resource constrained edge devices. One goal of eKuiper is to migrate the cloud streaming software frameworks (such as [Apache Spark](https://spark.apache.org)[Apache Storm](https://storm.apache.org) and [Apache Flink](https://flink.apache.org)) to edge side. eKuiper references these cloud streaming frameworks, and also considered special requirement of edge analytics, and introduced **rule engine**, which is based on ``Source``, ``SQL (business logic)`` and ``Sink``, rule engine is used for developing streaming applications at edge side.

![arch](./docs/en_US/arch.png)
![arch](docs/en_US/resources/arch.png)

**User scenarios**

Expand Down Expand Up @@ -82,7 +82,7 @@ Thank you for your contribution! Please refer to the [CONTRIBUTING.md](./docs/CO

- Using JMeter MQTT plugin to send simulation data to EMQ X Broker, such as: ``{"temperature": 10, "humidity" : 90}``, the value of temperature and humidity are random integer between 0 - 100.
- eKuiper subscribe from EMQ X Broker, and analyze data with SQL: ``SELECT * FROM demo WHERE temperature > 50 ``
- The analysis result are wrote to local file by using [file sink plugin](docs/en_US/plugins/sinks/file.md).
- The analysis result are wrote to local file by using [file sink plugin](docs/en_US/extension/native/sinks/file.md).

| Devices | Message # per second | CPU usage | Memory usage |
| ---------------------------------------------- | -------------------- | ------------- | ------------ |
Expand Down Expand Up @@ -133,11 +133,11 @@ Thank you for your contribution! Please refer to the [CONTRIBUTING.md](./docs/CO

- [Reference guide](docs/en_US/reference.md)
- [Install and operation](docs/en_US/operation/overview.md)
- [Command line interface tools - CLI](docs/en_US/cli/overview.md)
- [Command line interface tools - CLI](docs/en_US/operation/cli/overview.md)
- [eKuiper SQL reference](docs/en_US/sqls/overview.md)
- [Rules](docs/en_US/rules/overview.md)
- [Extend eKuiper](docs/en_US/extension/overview.md)
- [Plugins](docs/en_US/plugins/overview.md)
- [Plugins](docs/en_US/extension/native/develop/overview.md)

## Build from source

Expand All @@ -163,7 +163,7 @@ Thank you for your contribution! Please refer to the [CONTRIBUTING.md](./docs/CO

> Docker images support EdgeX by default
Prebuilt binaries are provided in the release assets. If using os or arch which does not have prebuilt binaries, please use cross-compilation, refer to [this doc](docs/en_US/cross-compile.md).
Prebuilt binaries are provided in the release assets. If using os or arch which does not have prebuilt binaries, please use cross-compilation, refer to [this doc](docs/en_US/operation/compile/cross-compile.md).

## Open source license

Expand Down
Loading

0 comments on commit d7457bc

Please sign in to comment.