You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampark.apache.org by ti...@apache.org on 2024/04/25 18:20:41 UTC
(incubator-streampark-website) branch dev updated: Update intro.md text changes to improve readability (#352)
This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 1fbac5b Update intro.md text changes to improve readability (#352)
1fbac5b is described below
commit 1fbac5bee18e83abc88410a40d4f56b326c96a69
Author: Andrew Wetmore <an...@cottage14.com>
AuthorDate: Thu Apr 25 15:20:36 2024 -0300
Update intro.md text changes to improve readability (#352)
* Update intro.md text changes to improve readability
line 11: corrected grammar and some noun-verb alignments
line 15: if you have 'including' at the start of a list, you do not need 'etc.' at the end.
line 17: a question requires a ? at the end
line 21: removed repetition
lines 30 and 63: removed empty bullet point
line 33: changed 'three parts' to 'two parts'
lines 41 and 64: rewrote sentences
* Apply suggestions from code review
---------
Co-authored-by: tison <wa...@gmail.com>
---
docs/intro.md | 28 +++++++++++++---------------
1 file changed, 13 insertions(+), 15 deletions(-)
diff --git a/docs/intro.md b/docs/intro.md
index d5d5bad..8cac6dd 100644
--- a/docs/intro.md
+++ b/docs/intro.md
@@ -10,36 +10,35 @@ Make stream processing easier!
## 🚀 What is Apache StreamPark™
-`Apache StreamPark` is an easy-to-use stream processing application development framework and one-stop stream processing operation platform, Aimed at ease building and managing streaming applications, StreamPark provides scaffolding for writing streaming process logics with Apache Flink and Apache Spark.
+Apache StreamPark is an easy-to-use stream processing application development framework and one-stop stream processing operation platform. Aimed to make it easy to build and manage streaming applications, StreamPark provides scaffolding for writing streaming process logic with Apache Flink and Apache Spark.
-StreamPark also provides a professional task management including task development, scheduling, interactive query, deployment, operation, maintenance, etc.
+StreamPark also provides a professional task management module including task development, scheduling, interactive queries, deployment, operations, and maintenance.
-## Why Apache StreamPark™
+## Why Apache StreamPark™?
-Apache Flink and Apache Spark are widely used as the next generation of big data streaming computing engines. Based on a bench of excellent experiences combined with best practices, we extracted the task deployment and runtime parameters into the configuration files. In this way, an easy-to-use `RuntimeContext` with out-of-the-box connectors would bring easier and more efficient task development experience. It reduces the learning cost and development barriers, hence developers can focus [...]
+Apache Flink and Apache Spark are widely used as the next generation of big data streaming computing engines. Based on a foundation of excellent experiences combined with best practices, we extracted the task deployment and runtime parameters into the configuration files. In this way, an easy-to-use `RuntimeContext` with out-of-the-box connectors can bring an easier and more efficient task development experience. It reduces the learning cost and development barriers, so developers can fo [...]
-On the other hand, It can be challenge for enterprises to use Flink & Spark if there is no professional management platform for Flink & Spark tasks during the deployment phase. StreamPark provides such a professional task management platform, including task development, scheduling, interactive query, deployment, operation, maintenance, etc.
+On the other hand, It can be challenge for enterprises to use Flink & Spark if there is no professional management platform for Flink & Spark tasks during the deployment phase. StreamPark provides such a professional task management platform as described above.
## 🎉 Features
* Apache Flink & Apache Spark application development scaffold
-* Support multiple versions of Flink & Spark
+* Supports multiple versions of Flink & Spark
* Wide range of out-of-the-box connectors
* One-stop stream processing operation platform
-* Support catalog、olap、streaming-warehouse etc.
-* ...
+* Supports catalog, OLAP, streaming warehouse, etc.
## 🏳🌈 Architecture of Apache StreamPark™
-The overall architecture of Apache StreamPark is shown in the following figure. Apache StreamPark consists of three parts, they are streampark-core and streampark-console.
+The overall architecture of Apache StreamPark is shown in the following figure. Apache StreamPark has two parts, `streampark-core` and `streampark-console`.

### 1️⃣ streampark-core
-The positioning of `streampark-core` is a framework uesd while developing, it focuses on coding development, regulates configuration files, and develops in the convention over configuration guide.
+`streampark-core` is a framework used during development. It supports coding development, regulates configuration files, and follows the 'convention over configuration' principle.
-`streampark-core` provides a development-time RunTime Content and a series of out-of-the-box Connectors. Cumbersome operations are simplified by extending DataStream-related methods and integrating DataStream and Flink SQL API. Development efficiency and development experience will be highly improved because users can focus on the business.
+`streampark-core` provides development-time Runtime Content and a series of out-of-the-box Connectors. Cumbersome operations are simplified by extending DataStream-related methods and integrating DataStream and the Flink SQL API. This improves development efficiency and developer experience, because users can focus on the business logic.
### 2️⃣ streampark-console
@@ -47,7 +46,7 @@ The positioning of `streampark-core` is a framework uesd while developing, it fo
It integrates the experience of many best practices and integrates many functions such as project compilation, release,
parameter configuration, startup, savepoint, flame graph, Flink SQL, monitoring, etc., which greatly simplifies the daily operation of Flink tasks and maintenance. The ultimate goal is to create a one-stop big data platform, which can provide a solution that integrates flow and batch, and integrates lake and warehouse.
-This platform uses technologies including but not limited to:
+This platform uses technologies including, but not limited to:
* [Apache Flink](http://flink.apache.org)
* [Apache Spark](http://spark.apache.org)
@@ -61,6 +60,5 @@ This platform uses technologies including but not limited to:
* [ANTD PRO VUE](https://pro.antdv)
* [xterm.js](https://xtermjs.org/)
* [Monaco Editor](https://microsoft.github.io/monaco-editor/)
-* ...
-
-Thanks for the respect given by the above excellent open source projects and many unmentioned excellent open source projects!
+
+Thanks for the support and inspiration given by the above excellent open source projects and many other excellent open source projects not mentioned here!