You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampark.apache.org by be...@apache.org on 2025/02/14 13:24:50 UTC
(streampark) branch dev updated: [Improve] update README (#4188)
This is an automated email from the ASF dual-hosted git repository.
benjobs pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampark.git
The following commit(s) were added to refs/heads/dev by this push:
new 894400517 [Improve] update README (#4188)
894400517 is described below
commit 894400517a5e95eddcffe142f092d42e6d4ce491
Author: benjobs <be...@apache.org>
AuthorDate: Fri Feb 14 21:24:44 2025 +0800
[Improve] update README (#4188)
* [Improve] update project introduction and key features
* [Improve] add quickstart video
* [Improve] dead-link check improvement
---
.github/workflows/docs.yml | 14 +---
README.md | 89 ++++++++++++----------
.../src/main/assembly/bin/streampark.sh | 11 +--
3 files changed, 57 insertions(+), 57 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 17f5763f7..a3fc1eab0 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -61,23 +61,11 @@ jobs:
submodules: true
- name: Check license header
uses: apache/skywalking-eyes/header@main
- dead-link:
- name: Dead links
- runs-on: ubuntu-latest
- needs: license-header
- timeout-minutes: 20
- steps:
- - uses: actions/checkout@v4
- - run: sudo npm install -g markdown-link-check@3.10.3
- - run: |
- for file in $(find . -name "*.md"); do
- markdown-link-check -c .dlc.json -q "$file"
- done
result:
name: Docs - Result
runs-on: ubuntu-latest
timeout-minutes: 30
- needs: [ paths-filter, license-header, dead-link ]
+ needs: [ paths-filter, license-header ]
if: always()
steps:
- uses: actions/checkout@v4
diff --git a/README.md b/README.md
index 7bde3ce06..d63025e14 100644
--- a/README.md
+++ b/README.md
@@ -16,49 +16,48 @@
~
-->
-<h1 align="center">
- <img src="https://streampark.apache.org/image/logo_name.png"
- alt="StreamPark Logo" title="Apache StreamPark Logo" width="600"/>
- <br>
-</h1>
+Apache StreamPark
+==========
-<h3 align="center">A magical framework that makes stream processing easier!</h3>
+<img src="https://streampark.apache.org/image/logo_name.png" alt="StreamPark logo" height="90px" align="right" />
-<div align="center">
+**StreamPark**: a streaming application development framework and cloud-native real-time computing platform.
-[](https://github.com/apache/streampark/stargazers)
+[](https://github.com/apache/streampark/stargazers)
[](https://github.com/apache/streampark/releases)
-[](https://streampark.apache.org/download)
-[](https://twitter.com/ASFStreamPark)
+[](https://x.com/ASFStreamPark)
-**[Website](https://streampark.apache.org)** |
-**[Official Docs](https://streampark.apache.org/docs/get-started/intro)** |
-**[FAQ](https://github.com/apache/streampark/issues/507)**
+[?style=for-the-badge>)](https://streampark.apache.org/)
-
+## 📊 Overview
-</div>
+**StreamPark** is a streaming application development framework and cloud-native real-time computing platform. Designed to simplify the development and management of streaming applications, StreamPark provides a development framework for constructing stream processing applications using Apache Flink and Apache Spark, along with a professional streaming application management platform. The platform encompasses application development, debugging, interactive querying, deployment, operation [...]
+* **Streaming Application Development Framework**
+ * StreamPark provides a Streaming application framework to simplify Apache Flink and Apache Spark application development, offering plug-and-play connectors to reduce the learning curve and development complexity.
+* **Real-Time Computing Platform**
+ * StreamPark delivers a one-stop real-time computing platform with core capabilities including application development, deployment, management and monitoring, etc.
+* **Supports Batch & Streaming**
+ * Supports both Apache Flink and Apache Spark, enabling seamless integration of streaming and batch processing, with multi-engine/multi-version support on a single platform.
+* **Supports multi-engine/multi-version**
+ * StreamPark supports multiple versions of Apache Flink and Apache Spark, enabling users to develop and manage applications for different versions of these streaming engines within a single framework.
+* **Multi-environment Compatibility**
+ * Compatible with various cluster environments, users can submit Flink and Spark applications to standalone clusters, YARN (Hadoop 2.x/3.x), and Kubernetes.
+* **Rich Ecosystems**
+ * Compatible with mainstream open-source technologies (e.g., Apache Flink, Apache Spark, Apache Paimon, Apache Doris) and ML/AI ecosystems, ensuring flexible technology adoption.
+* **Easy to use**
+ * StreamPark is designed to lower the learning curve and entry barrier. Only one service, deployment easy, allowing even beginners to get started within minutes.
-## 🚀 Abstract
-
-----
-<h4>Apache StreamPark™ is a stream processing development framework and application management platform. </h4>
-
-> Apache StreamPark™ is a streaming application development framework. Aimed at ease building and managing streaming applications, StreamPark provides development framework for writing stream processing application with Apache Flink and Apache Spark, More other engines will be supported in the future. Also, StreamPark is a professional management platform for streaming application, including application development, debugging, interactive query, deployment, operation, maintenance, etc. I [...]
-
-* Apache Flink & Apache Spark application development scaffold
-* Support multiple versions of Apache Flink & Apache Spark
-* Wide range of out-of-the-box connectors
-* One-stop stream processing operation platform
-* Support catalog、olap、streaming-warehouse etc.
-* ...
+<img src="https://streampark.apache.org/image/dashboard-preview.png"/>
## 🚀 QuickStart
```shell
curl -L https://streampark.apache.org/quickstart.sh | sh
```
+
+https://github.com/user-attachments/assets/dd7d5a89-bc28-4ccc-9ad5-258925fc4f34
+
more:
- [Start with Docker](docker/README.md)
- [Start with Kubernetes](helm/README.md)
@@ -70,18 +69,23 @@ more:
./build.sh
```
-🗄 Details:how to [Development](https://streampark.apache.org/docs/development/development)
+🗄 how to [Development](https://streampark.apache.org/docs/development/development)
+
+## ⬇️ Downloads
-## 🧑💻 Downloads
+Please head to the [releases page](https://streampark.apache.org/download) to download a release of Apache StreamPark.
-Download address for run-directly software package: https://streampark.apache.org/download
+## 📚 Docs
+
+[Official Documentation](https://streampark.apache.org/docs/get-started)
## 💋 Our users
-Various companies and organizations use Apache StreamPark™ for research, production and commercial products. Are you using this project? [Welcome to add your company](https://github.com/apache/streampark/issues/163)!
+Various companies and organizations use Apache StreamPark for research, production and commercial products. Are you using this project? [Welcome to add your company](https://github.com/apache/streampark/issues/163)!
+
## 🤝 Contribution
[](https://github.com/apache/streampark/pulls)
@@ -96,18 +100,20 @@ You can submit any ideas as [pull requests](https://github.com/apache/streampark
We welcome your suggestions, comments (including criticisms), comments and contributions. See [How to Contribute](https://streampark.apache.org/community/submit_guide/submit_code) and [Code Submission Guide](https://streampark.apache.org/community/submit_guide/code_style_and_quality_guide)
-### 📤 Subscribe Mailing Lists
-Mail List is the most recognized form of communication in Apache community. See how to [Join the Mailing Lists](https://streampark.apache.org/community/contribution_guide/mailing_lists)
-
-Thank you to all the people who already contributed to Apache StreamPark™!
+Thank you to all the people who already contributed to Apache StreamPark!
[](https://github.com/apache/streampark/graphs/contributors)
-## License
+## 💬 Contact Us
+
+Contact us through the following mailing list.
+
+| Name | Mailing list |
+|:--------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [dev@streampark.apache.org](mailto:dev@streampark.apache.org) | [Subscribe](mailto:dev-subscribe@streampark.apache.org)、[Unsubscribe](mailto:dev-unsubscribe@streampark.apache.org) 、[Archives](http://mail-archives.apache.org/mod_mbox/streampark-dev/) |
-Licensed under the [Apache License, Version 2.0](LICENSE)
-## 💬 Social Media
+## 💿 Social Media
- [X (Twitter)](https://twitter.com/ASFStreamPark)
- [Zhihu](https://www.zhihu.com/people/streampark) (in Chinese)
@@ -115,3 +121,8 @@ Licensed under the [Apache License, Version 2.0](LICENSE)
- WeChat Official Account (in Chinese, scan the QR code to follow)
<img src="https://streampark.apache.org/image/wx_qr.png" alt="Join the Group" height="350px"><br>
+
+
+## 📜 License
+
+Licensed under the [Apache License, Version 2.0](LICENSE)
diff --git a/streampark-console/streampark-console-service/src/main/assembly/bin/streampark.sh b/streampark-console/streampark-console-service/src/main/assembly/bin/streampark.sh
index c83c3119b..5045c7892 100755
--- a/streampark-console/streampark-console-service/src/main/assembly/bin/streampark.sh
+++ b/streampark-console/streampark-console-service/src/main/assembly/bin/streampark.sh
@@ -277,12 +277,12 @@ print_logo() {
printf ' %s ___/ / /_/ / / __/ /_/ / / / / / / /_/ / /_/ / / / ,< %s\n' $PRIMARY $RESET
printf ' %s /____/\__/_/ \___/\__,_/_/ /_/ /_/ ____/\__,_/_/ /_/|_| %s\n' $PRIMARY $RESET
printf ' %s /_/ %s\n\n' $PRIMARY $RESET
- printf ' %s Version: 2.2.0 %s\n' $BLUE $RESET
- printf ' %s WebSite: https://streampark.apache.org%s\n' $BLUE $RESET
- printf ' %s GitHub : http://github.com/apache/streampark%s\n\n' $BLUE $RESET
- printf ' %s ──────── Apache StreamPark, Make stream processing easier ô~ô!%s\n\n' $PRIMARY $RESET
+ printf ' %s Version: 2.2.0 %s\n' $BLUE $RESET
+ printf ' %s WebSite: https://streampark.apache.org%s\n' $BLUE $RESET
+ printf ' %s GitHub : http://github.com/apache/streampark%s\n\n' $BLUE $RESET
+ printf ' %s ──────── Apache StreamPark, Make stream processing easier ô~ô!%s\n\n' $PRIMARY $RESET
if [[ "$1"x == "start"x ]]; then
- printf ' %s http://localhost:%s %s\n\n' $PRIMARY $SERVER_PORT $RESET
+ printf ' %s http://localhost:'$SERVER_PORT' %s\n\n' $PRIMARY $RESET
fi
}
@@ -438,6 +438,7 @@ start_docker() {
# shellcheck disable=SC2091
local APP_CLASSPATH=".:${JAVA_HOME}/lib:${JAVA_HOME}/jre/lib"
# shellcheck disable=SC2206
+ # shellcheck disable=SC2155
# shellcheck disable=SC2010
local JARS=$(ls "$APP_LIB"/*.jar | grep -v "$APP_LIB/streampark-flink-shims_.*.jar$")
# shellcheck disable=SC2128