Skip to content

Commit

Permalink
docs: proofread the en-us index page (#2764)
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Khizhniak <[email protected]>
  • Loading branch information
alxkhi committed Apr 8, 2024
1 parent 5c6934c commit bab777a
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions docs/en_US/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

LF Edge eKuiper is a lightweight IoT data analytics and stream processing engine running on resource-constraint edge
devices. The major goal for eKuiper is to provide a streaming software framework (similar
to [Apache Flink](https://flink.apache.org)) in edge side. eKuiper's **rule engine** allows user to provide either
SQL-based or graph based (similar to Node-RED) rules to create IoT edge analytics applications within few minutes.
to [Apache Flink](https://flink.apache.org)) on the edge side. eKuiper's **rule engine** allows users to provide either
SQL-based or graph-based (similar to Node-RED) rules to create IoT edge analytics applications within a few minutes.

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

## Features

- Lightweight

- Core server package is only about 4.5M, memory footprint is about 10MB.
- The core server package is only about 4.5M, the memory footprint is about 10MB.

- Cross-platform

Expand All @@ -21,29 +21,29 @@ SQL-based or graph based (similar to Node-RED) rules to create IoT edge analytic

- Data analysis support

- Support data ETL
- Supports data ETL
- Data order, group, aggregation and join with different data sources (the data from databases and files)
- 60+ functions, includes mathematical, string, aggregate and hash etc
- 4 time windows & count window
- 60+ functions, including mathematical, string, aggregate and hash, etc.
- 4 time windows and a count window

- Highly extensible

It supports extending at `Source`, `Functions` and `Sink` with Golang or Python.

- Source: allows users to add more data sources for analytics.
- Sink: allows users to send the analysis result to different customized systems.
- UDF functions: allow users to add customized functions for data analysis (for example, AI/ML function invocation)
- UDF functions: allow users to add customized functions for data analysis (for example, AI/ML function invocation).

- Management

- [A free web based management dashboard](https://hub.docker.com/r/emqx/ekuiper-manager) for visualized management
- Plugins, streams and rules management through CLI, REST API and config maps(Kubernetes)
- Easily be integrated with Kubernetes
frameworks [KubeEdge](https://github.com/kubeedge/kubeedge), [OpenYurt](https://openyurt.io/), [K3s](https://github.com/rancher/k3s) [Baetyl](https://github.com/baetyl/baetyl)
- [A free web-based management dashboard](https://hub.docker.com/r/emqx/ekuiper-manager) for visualized management
- Plugins, streams and rules management through CLI, REST API and config maps (Kubernetes)
- Can be easily integrated with Kubernetes
frameworks [KubeEdge](https://github.com/kubeedge/kubeedge), [OpenYurt](https://openyurt.io/), [K3s](https://github.com/rancher/k3s), [Baetyl](https://github.com/baetyl/baetyl)

- Integration with EMQX products

Seamless integration with [EMQX](https://www.emqx.io/), [Neuron](https://neugates.io/) & [NanoMQ](https://nanomq.io/), and provided an end-to-end solution from IIoT, IoV
Seamless integration with [EMQX](https://www.emqx.io/), [Neuron](https://neugates.io/) and [NanoMQ](https://nanomq.io/), and provided an end-to-end solution from IIoT, IoV

## Understand eKuiper

Expand All @@ -61,7 +61,7 @@ Learn about eKuiper and its fundamental concepts.

## Try eKuiper

Follow tutorials to learn how to use eKuiper.
Follow the tutorials to learn how to use eKuiper.

- [Getting started locally](./getting_started/getting_started.md)
- [Getting started in Docker](./getting_started/quick_start_docker.md)
Expand Down Expand Up @@ -105,17 +105,17 @@ Learn how to develop custom extensions.

If you get stuck, check out our community support resources.

- Open GitHub [issue](https://github.com/lf-edge/ekuiper/issues).
- Open a GitHub [issue](https://github.com/lf-edge/ekuiper/issues).
- Ask in the [forum](https://askemq.com/c/ekuiper).
- Join our [Slack](https://slack.lfedge.org/), and then join [ekuiper](https://lfedge.slack.com/archives/C024F4P7KCK) or [ekuiper-user](https://lfedge.slack.com/archives/C024F4SMEMR) channel.
- Join our [Slack](https://slack.lfedge.org/), and then join the [ekuiper](https://lfedge.slack.com/archives/C024F4P7KCK) or [ekuiper-user](https://lfedge.slack.com/archives/C024F4SMEMR) channel.
- Mail to eKuiper help [mail list](mailto:[email protected]).
- Join WeChat group, scan the below QR code and mark "eKuiper".
- Join the WeChat group, scan the QR code below and mark "eKuiper".

<img src="./wechat.png" alt="drawing" width="200"/>

## Contribute

Anyone can contribute for anything, not just code.
Anyone can contribute to anything, not just code.

- [Edit Doc in GitHub](https://github.com/lf-edge/ekuiper/tree/master/docs)
- [How to contribute](./CONTRIBUTING.md)

0 comments on commit bab777a

Please sign in to comment.