From bab777af76fd1dd097ece923dc92fc3014ffa040 Mon Sep 17 00:00:00 2001 From: Alex Khizhniak <165982499+alxkhi@users.noreply.github.com> Date: Mon, 8 Apr 2024 08:41:46 +0200 Subject: [PATCH] docs: proofread the en-us index page (#2764) Signed-off-by: Alex Khizhniak <165982499+alxkhi@users.noreply.github.com> --- docs/en_US/index.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/en_US/index.md b/docs/en_US/index.md index 1cba708370..256caaef9f 100644 --- a/docs/en_US/index.md +++ b/docs/en_US/index.md @@ -2,8 +2,8 @@ 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) @@ -11,7 +11,7 @@ SQL-based or graph based (similar to Node-RED) rules to create IoT edge analytic - 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 @@ -21,10 +21,10 @@ 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 @@ -32,18 +32,18 @@ SQL-based or graph based (similar to Node-RED) rules to create IoT edge analytic - 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 @@ -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) @@ -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:ekuiper+help@lists.lfedge.org). -- Join WeChat group, scan the below QR code and mark "eKuiper". +- Join the WeChat group, scan the QR code below and mark "eKuiper". drawing ## 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)