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 2023/01/12 04:03:06 UTC
[incubator-streampark] branch dev updated: [Improve] update project introduction (#2250)
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/incubator-streampark.git
The following commit(s) were added to refs/heads/dev by this push:
new cc670eafb [Improve] update project introduction (#2250)
cc670eafb is described below
commit cc670eafb98a262c3383773be0229bc75d06f35f
Author: benjobs <be...@apache.org>
AuthorDate: Thu Jan 12 12:03:01 2023 +0800
[Improve] update project introduction (#2250)
* update intro in readme
---
README.md | 70 +++++++++++-------------
README_CN.md | 106 -------------------------------------
dist-material/release-docs/LICENSE | 2 +-
3 files changed, 32 insertions(+), 146 deletions(-)
diff --git a/README.md b/README.md
index ed87d87af..0c4814a9e 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,26 @@
-<div align="center">
- <br/>
- <h1>
- <a href="https://streampark.apache.org" target="_blank" rel="noopener noreferrer">
- <img width="600" src="https://streampark.apache.org/image/logo_name.png" alt="StreamPark logo">
- </a>
- </h1>
- <strong style="font-size: 1.5rem">Make stream processing easier!!!</strong>
-</div>
-
-<br/>
-
-<p align="center">
- <img src="https://tokei.rs/b1/github/apache/streampark">
- <img src="https://img.shields.io/github/v/release/apache/streampark.svg">
- <img src="https://img.shields.io/github/stars/apache/streampark">
- <img src="https://img.shields.io/github/forks/apache/streampark">
- <img src="https://img.shields.io/github/issues/apache/streampark">
- <img src="https://img.shields.io/github/downloads/apache/streampark/total.svg">
- <img src="https://img.shields.io/github/languages/count/apache/streampark">
- <a href="https://www.apache.org/licenses/LICENSE-2.0.html"><img src="https://img.shields.io/badge/license-Apache%202-4EB1BA.svg"></a>
-</p>
-
-<div align="center">
-
-**[Official Website](https://streampark.apache.org)** |
-**[Document](https://streampark.apache.org/docs/intro)**
-
-</div>
-
-#### English | [中文](README_CN.md)
-
# Apache StreamPark (Incubating)
+<br>
+<a href="https://streampark.apache.org" target="_blank" rel="noopener noreferrer">
+ <img width="600" src="https://streampark.apache.org/image/logo_name.png" alt="StreamPark logo">
+</a>
-Make stream processing easier
+### A magical framework that makes stream processing easier!
-> A magical framework that make stream processing easier!
+[](https://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://github.com/apache/streampark/graphs/commit-activity)
+[](https://github.com/apache/streampark)
+
+[](https://github.com/apache/incubator-streampark/releases)
+[](https://streampark.apache.org/download)
-## 🚀 Introduction
+**[Official Website](https://streampark.apache.org)**
+| **[Document](https://streampark.apache.org/docs/intro)**
+| **[FAQ](https://github.com/apache/incubator-streampark/issues/507)**
+<br>
+## 🚀 What is 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 [...]
-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.
+StreamPark is a streaming application development framework. Aimed at ease building and managing streaming applications, StreamPark provides development framework for writing streaming process 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. It was initially known as StreamX and renamed to StreamPark in August 2022.
## 🎉 Features
@@ -57,12 +38,23 @@ On the other hand, It can be challenge for enterprises to use Flink & Spark if t

+## 🔨 How to Build
+
+```shell
+git clone git@github.com:apache/incubator-streampark.git
+cd incubator-streampark
+./build.sh
+```
+
+## 🧑💻 Downloads
+
+Download address for run-directly software package : [https://streampark.apache.org/download](https://streampark.apache.org/download)
## 🚀 Quick Start
-click [Document](https://streampark.apache.org/docs/intro) for more information
+click [Document](https://streampark.apache.org/docs/user-guide/quick-start) for more information
-## 💋 our users
+## 💋 Our users
Various companies and organizations use StreamPark for research, production and commercial products. Are you using this project ? [you can add your company](https://github.com/apache/incubator-streampark/issues/163)
diff --git a/README_CN.md b/README_CN.md
deleted file mode 100644
index 203c5ae42..000000000
--- a/README_CN.md
+++ /dev/null
@@ -1,106 +0,0 @@
-<div align="center">
- <br/>
- <h1>
- <a href="https://streampark.apache.org" target="_blank" rel="noopener noreferrer">
- <img width="600" src="https://streampark.apache.org/image/logo_name.png" alt="StreamPark logo">
- </a>
- </h1>
- <strong style="font-size: 1.5rem">Make stream processing easier!!!</strong>
-</div>
-
-<br/>
-
-<p align="center">
- <img src="https://tokei.rs/b1/github/apache/streampark">
- <img src="https://img.shields.io/github/v/release/apache/streampark.svg">
- <img src="https://img.shields.io/github/stars/apache/streampark">
- <img src="https://img.shields.io/github/forks/apache/streampark">
- <img src="https://img.shields.io/github/issues/apache/streampark">
- <img src="https://img.shields.io/github/downloads/apache/streampark/total.svg">
- <img src="https://img.shields.io/github/languages/count/apache/streampark">
- <a href="https://www.apache.org/licenses/LICENSE-2.0.html"><img src="https://img.shields.io/badge/license-Apache%202-4EB1BA.svg"></a>
-</p>
-
-
-<div align="center">
-
-**[官网](https://streampark.apache.org)** |
-**[使用文档](https://streampark.apache.org/docs/intro)**
-
-</div>
-
-#### [English](README.md) | 中文
-
-# Apache StreamPark (Incubating)
-
-Make stream processing easier
-
-> 一个神奇的框架,让流处理更简单。
-
-## 🚀 什么是 StreamPark
-
-实时即未来,在实时处理流域 `Apache Spark` 和 `Apache Flink` 是一个伟大的进步,尤其是 `Apache Flink` 被普遍认为是下一代大数据流计算引擎。我们在使用 `Flink` & `Spark` 时发现从编程模型、参数配置到项目部署、运维管理都有很多可以抽象共用的地方,我们将一些好的经验固化下来并结合业内的最佳实践。通过不断努力,终于诞生了今天的框架 —— `StreamPark`。项目的初衷是 —— **让流处理更简单**。
-
-使用 `StreamPark` 开发,可以极大降低学习成本和开发门槛,让开发者只用关心最核心的业务。`StreamPark` 规范了项目的配置,鼓励函数式编程,定义了最佳的编程方式,提供了一系列开箱即用的 `Connectors`,标准化了配置、开发、测试、部署、监控、运维的整个过程,提供了 Scala/Java 两套 API,其最终目的是打造一个一站式大数据平台,流批一体、湖仓一体的解决方案。
-
-## 🎉 Features
-
-* Apache Flink & Spark 开发脚手架
-* 提供了一系列开箱即用的 Connectors
-* 支持项目编译功能(Maven 编译)
-* 多版本 Flink & Spark 支持
-* Scala 2.11 / 2.12 支持
-* 一站式的流任务管理平台
-* 支持不限于 Catalog、OLAP、streaming-warehouse
-* ...
-
-
-
-
-
-## 🚀 快速上手
-
-请查看[官网文档](https://streampark.apache.org/docs/intro)了解更多使用信息
-
-## 💋 谁在使用
-
-诸多公司和组织将 StreamPark 用于研究、生产和商业产品中,如果您也在使用 ? 可以在[这里添加](https://github.com/apache/incubator-streampark/issues/163)
-
-
-
-## 🏆 我们的荣誉
-
-我们获得了一些珍贵的荣誉,这份荣誉属于参加建设 StreamPark 的每一位朋友,谢谢大家!
-
-
-
-
-
-## 🤝 我要贡献
-
-[](https://github.com/apache/incubator-streampark/pulls)
-
-如果你希望参与贡献 欢迎 [Pull Request](https://github.com/apache/incubator-streampark/pulls),或给我们 [报告 Bug](https://github.com/apache/incubator-streampark/issues/new/choose)。
-
-> 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)(**本指南不提供此项目的实际支持服务!**)、[《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393),更好的问题更容易获得帮助。
-
-感谢所有向 StreamPark 贡献的朋友!
-
-<a href="https://github.com/apache/incubator-streampark/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=apache/streampark" />
-</a>
-
-
-## ⏰ Contributor Over Time
-
-[](https://git-contributor.com?chart=contributorOverTime&repo=apache/incubator-streampark)
-
-## 👍Stargazers Over Time
-
-
-
-## 💬 Join Us (微信公众号)
-
-<div align="center">
- <img src="https://streampark.apache.org/image/wx_qr.png" alt="Join the Group" height="400px"><br>
-</div>
diff --git a/dist-material/release-docs/LICENSE b/dist-material/release-docs/LICENSE
index fa6501949..eefde1f00 100644
--- a/dist-material/release-docs/LICENSE
+++ b/dist-material/release-docs/LICENSE
@@ -188,7 +188,7 @@ licenses.
Apache-2.0 licenses
========================================================================
The following components are provided under the Apache-2.0 License. See project link for details.
-The text of each license is the standard Apache 2.0 license.
+The text of each license is the standard Apache 2.0 license. https://www.apache.org/licenses/LICENSE-2.0.txt
https://mvnrepository.com/artifact/com.aliyun.oss/aliyun-sdk-oss/3.15.0 Apache-2.0
https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-core/4.5.10 Apache-2.0