You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampark.apache.org by ca...@apache.org on 2024/04/29 07:13:44 UTC
(incubator-streampark) branch dev updated: [Improve] DISCLAIMER and README.md improvement (#3683)
This is an automated email from the ASF dual-hosted git repository.
cancai 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 fe536ef7e [Improve] DISCLAIMER and README.md improvement (#3683)
fe536ef7e is described below
commit fe536ef7e24db2adeaaa298e1e8933899b61f834
Author: benjobs <be...@apache.org>
AuthorDate: Mon Apr 29 15:13:39 2024 +0800
[Improve] DISCLAIMER and README.md improvement (#3683)
* [Improve] DISCLAIMER improvement
* [Improve] streampark image tag improvement in docker/docker-compose.yaml
---------
Co-authored-by: benjobs <be...@gmail.com>
---
DISCLAIMER | 11 +----------
README.md | 9 ++++-----
docker/README.md | 16 +++++++++++++---
docker/docker-compose.yaml | 2 +-
4 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/DISCLAIMER b/DISCLAIMER
index e95e776bc..0996f9568 100644
--- a/DISCLAIMER
+++ b/DISCLAIMER
@@ -1,10 +1 @@
-Apache StreamPark (incubating) is an effort undergoing incubation at the Apache
-Software Foundation (ASF), sponsored by the Apache Incubator PMC.
-
-Incubation is required of all newly accepted projects until a further review
-indicates that the infrastructure, communications, and decision making process
-have stabilized in a manner consistent with other successful ASF projects.
-
-While incubation status is not necessarily a reflection of the completeness
-or stability of the code, it does indicate that the project has yet to be
-fully endorsed by the ASF.
+Apache StreamPark is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the proj [...]
diff --git a/README.md b/README.md
index ad42afc21..129cd1195 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@
[](https://twitter.com/ASFStreamPark)
**[Website](https://streampark.apache.org)** |
-**[Document](https://streampark.apache.org/docs/intro)** |
+**[Documentation](https://streampark.apache.org/docs/intro)** |
**[FAQ](https://github.com/apache/incubator-streampark/issues/507)**
@@ -40,14 +40,13 @@
</div>
-## 🚀 What is Apache StreamPark™?
+## 🚀 Abstract
+----
<h4>Apache StreamPark is a stream processing development framework and professional 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. It [...]
-## 🎉 Features
-
* Apache Flink & Apache Spark application development scaffold
* Support multiple versions of Flink & Spark
* Wide range of out-of-the-box connectors
@@ -62,7 +61,7 @@
- [Start with Docker](docker/README.md)
- [Start with Kubernetes](helm/README.md)
-Click [Document](https://streampark.apache.org/docs/user-guide/quick-start) for more information
+Click [Official documentation](https://streampark.apache.org/docs/user-guide/quick-start) for more information
## 🔨 How to Build
diff --git a/docker/README.md b/docker/README.md
index 486bb9849..bfcbf78d3 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,12 +1,22 @@
-# Deploy StreamPark on Docker
-### 1. docker-compose up
+### 1. Confirm release version
+When releasing the new version, the release manager will verify the image tag and push the image to the image repository,
+The latest image tag will be written to [docker-compose.yaml](./docker-compose.yaml)，users also can independently verify whether the version of the StreamPark image in the [docker-compose.yaml](./docker-compose.yaml) file is correct (If the current branch has not been released, the image tag is the last release image tag):
+
+```yaml
+version: '3.8'
+services:
+ streampark-console:
+ image: apache/streampark:2.1.4
+```
+
+### 2. docker-compose up
```shell
docker-compose up -d
```
-### 2. open in browser
+### 3. open in browser
http://localhost:10000
diff --git a/docker/docker-compose.yaml b/docker/docker-compose.yaml
index cd3e7eef5..3c1544cfd 100644
--- a/docker/docker-compose.yaml
+++ b/docker/docker-compose.yaml
@@ -17,7 +17,7 @@
version: '3.8'
services:
streampark-console:
- image: apache/streampark:latest
+ image: apache/streampark:2.1.4
command: ${RUN_COMMAND}
ports:
- 10000:10000