Skip to content

Commit

Permalink
[TLP] Graduate Apache StreamPark (Incubating) as a Top Level Project (#…
Browse files Browse the repository at this point in the history
…421)

* [TLP] Graduate Apache StreamPark (Incubating) as a Top Level Project

* [Improve] minor improvement
  • Loading branch information
wolfboys authored Jan 17, 2025
1 parent 948deaa commit 63b94a6
Show file tree
Hide file tree
Showing 68 changed files with 214 additions and 296 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[English](README.md) | [中文](README_ZH.md)

This is the repository containing all the source code of `http://streampark.apache.org`.
This guide will guide you how to contribute to the Apache StreamPark™ (Incubating) website.
This guide will guide you how to contribute to the Apache StreamPark™ website.

## Branch

Expand All @@ -18,7 +18,7 @@ This website is compiled using Node.js (version >=18), using [Docusaurus (3.3.2)
To download and preview the website:

```shell
git clone https://github.com/apache/incubator-streampark-website.git streampark-website
git clone https://github.com/apache/streampark-website.git streampark-website
cd streampark-website
pnpm install
pnpm run start
Expand Down
4 changes: 2 additions & 2 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[English](README.md) | [中文](README_ZH.md)

这是包含 `http://streampark.apache.org` 的所有源代码的存储库。本指南将指导您如何为 Apache StreamPark™ (Incubating) 的网站做出贡献。
这是包含 `http://streampark.apache.org` 的所有源代码的存储库。本指南将指导您如何为 Apache StreamPark™ 的网站做出贡献。

## 分支

Expand All @@ -17,7 +17,7 @@ dev 为默认主分支,修改请先 fork 到自己的仓库,然后切换到
运行以下命令下载网站源代码并在本地预览:

```shell
git clone https://github.com/apache/incubator-streampark-website.git streampark-website
git clone https://github.com/apache/streampark-website.git streampark-website
cd streampark-website
pnpm install
pnpm run start
Expand Down
2 changes: 1 addition & 1 deletion blog/1-flink-framework-streampark.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ It's a universal truth that innovations aren't perfect from the outset. Although

Resources:

StreamPark GitHub: [https://github.com/apache/incubator-streampark](https://github.com/apache/incubator-streampark) <br/>
StreamPark GitHub: [https://github.com/apache/streampark](https://github.com/apache/streampark) <br/>
Doris GitHub: [https://github.com/apache/doris](https://github.com/apache/doris)

![](/blog/belle/author.png)
2 changes: 1 addition & 1 deletion blog/11-streampark-usercase-tianyancha.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ In the StreamPark landing practice, we also encountered some problems, which are
### **Huawei Cloud has compatibility issues with open source Hadoop**

Our jobs are in Flink on Yarn mode and deployed in Huawei Cloud. During the process of using StreamPark to deploy jobs, we found that the jobs can be successfully deployed to Huawei Hadoop cluster, but the request for Yarn ResourceManager was rejected when getting the job status information, so we communicated with the community in time to find a solution, and logged the issue.
https://github.com/apache/incubator-streampark/issues/3566
https://github.com/apache/streampark/issues/3566

We communicated with the community to seek a solution, and recorded the issue: . Finally, with the assistance of Mr. Huajie, a community PMC member, and Huawei Cloud students, we successfully resolved the issue: StreamPark could not access the cloud ResourceManager properly due to the internal security authentication mechanism of the cloud product itself.

Expand Down
2 changes: 1 addition & 1 deletion blog/3-streampark-usercase-bondex-paimon.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Continuing the characteristics of the Kappa architecture with a single stream pr

This solution adopts Flink Application on K8s clusters, with Flink CDC for real-time ingestion of relational database data from business systems. Tasks for Flink + Paimon Streaming Data Warehouse are submitted through the StreamPark task platform, with the Trino engine ultimately used to access Finereport for service provision and developer queries. Paimon's underlying storage supports the S3 protocol, and as the company's big data services rely on Alibaba Cloud, Object Storage Service (OSS) is used as the data filesystem.

[StreamPark](https://github.com/apache/incubator-streampark) is a real-time computing platform that leverages the powerful capabilities of [Paimon](https://github.com/apache/incubator-paimon) to process real-time data streams. This platform offers the following key features:
[StreamPark](https://github.com/apache/streampark) is a real-time computing platform that leverages the powerful capabilities of [Paimon](https://github.com/apache/incubator-paimon) to process real-time data streams. This platform offers the following key features:

**Real-time Data Processing: **StreamPark supports the submission of real-time data stream tasks, capable of real-time acquisition, transformation, filtering, and analysis of data. This is extremely important for applications that require rapid response to real-time data, such as real-time monitoring, real-time recommendations, and real-time risk control.

Expand Down
10 changes: 5 additions & 5 deletions community/contribution_guide/SPIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ closed and transfer from [current SPIPs][current-SPIPs] to [past SPIPs][past-SPI

* [[SPIP-1][Feature][Parent] Suggest add HA for StreamPark][SPIP-1]: Have multiple subtasks and Projects on it.

[all-SPIPs]: https://github.com/apache/incubator-streampark/issues?q=is%3Aissue+label%3A%22SPIP%22+
[current-SPIPs]: https://github.com/apache/incubator-streampark/issues?q=is%3Aissue+is%3Aopen+label%3A%22SPIP%22
[past-SPIPs]: https://github.com/apache/incubator-streampark/issues?q=is%3Aissue+is%3Aclosed+label%3A%22SPIP%22+
[github-issue-choose]: https://github.com/apache/incubator-streampark/issues/new/choose
[all-SPIPs]: https://github.com/apache/streampark/issues?q=is%3Aissue+label%3A%22SPIP%22+
[current-SPIPs]: https://github.com/apache/streampark/issues?q=is%3Aissue+is%3Aopen+label%3A%22SPIP%22
[past-SPIPs]: https://github.com/apache/streampark/issues?q=is%3Aissue+is%3Aclosed+label%3A%22SPIP%22+
[github-issue-choose]: https://github.com/apache/streampark/issues/new/choose
[mail-to-dev]: mailto:[email protected]
[SPIP-1]: https://github.com/apache/incubator-streampark/issues/3905
[SPIP-1]: https://github.com/apache/streampark/issues/3905

4 changes: 2 additions & 2 deletions community/contribution_guide/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
First of all, thank you very much for choosing and using StreamPark, and welcome to join the StreamPark family!

We encourage any form of participation in the community that will eventually become Committer or PPMC Such as:
* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-streampark/issues) form feedback out.
* Problems will be encountered via github on the [issue](https://github.com/apache/streampark/issues) form feedback out.
* Answer the issue questions that others are asking.
* Help improve the documentation.
* Help your project add test cases.
Expand Down Expand Up @@ -31,7 +31,7 @@ Refer to the [Submit Guide-Pull Request Notice](./pull-request.md), [Submit Guid

If you want to implement a Feature or fix a Bug. Please refer to the following:

* All bugs and the features are recommended and managed using the GitHub issues(https://github.com/apache/incubator-streampark/issues).
* All bugs and the features are recommended and managed using the GitHub issues(https://github.com/apache/streampark/issues).
* If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment.
* It's a good idea to find a mentor (or an instructor) in the core contributors who gives immediate feedback on design and functional implementation.
* You should create a new branch to start your work, to get the name of the branch refer to the [Submit Guide-Pull Request Notice](./pull-request.md). For example, if you want to complete the feature and submit Issue 111, your branch name should be feature-111. The feature name can be determined after discussion with the instructor.
Expand Down
4 changes: 2 additions & 2 deletions community/contribution_guide/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Good documentation is critical for any type of software. Any contribution that c

### Get the document project

Documentation for the StreamPark project is maintained in a separate [git repository](https://github.com/apache/incubator-streampark-website).
Documentation for the StreamPark project is maintained in a separate [git repository](https://github.com/apache/streampark-website).

First you need to fork the document project into your own github repository, and then clone the document to your local computer.

```
git clone https://github.com/<your-github-user-name>/incubator-streampark-website
```

For more information on how to develop document locally, please refer to the [documentation contribution guide](https://github.com/apache/incubator-streampark-website/blob/dev/README.md)
For more information on how to develop document locally, please refer to the [documentation contribution guide](https://github.com/apache/streampark-website/blob/dev/README.md)
4 changes: 2 additions & 2 deletions community/contribution_guide/e2e-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ The current community E2E test has not yet reached full coverage, so this docume

The E2E test pages are currently divided into four pages: Project Management, Resource Center, DataSource, and Security Center.

Contributors can find the task by going to GitHub, searching for [apache/incubator-streampark](https://github.com/apache/incubator-streampark), and then searching for `e2e` in the [issue list](https://github.com/apache/incubator-streampark/issues?q=is%3Aissue+is%3Aopen+e2e). As shown below.
Contributors can find the task by going to GitHub, searching for [apache/incubator-streampark](https://github.com/apache/streampark), and then searching for `e2e` in the [issue list](https://github.com/apache/streampark/issues?q=is%3Aissue+is%3Aopen+e2e). As shown below.

For more information on e2e development, please refer to the [E2E](https://github.com/apache/incubator-streampark/blob/dev/streampark-e2e/README.md).
For more information on e2e development, please refer to the [E2E](https://github.com/apache/streampark/blob/dev/streampark-e2e/README.md).
2 changes: 1 addition & 1 deletion community/contribution_guide/new_committer_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ This is a formal vote about inviting ${NEW_COMMITTER_NAME} as our new committer.
${Work list}[1]
[1] https://github.com/apache/incubator-streampark/commits?author=${NEW_COMMITTER_NAME}
[1] https://github.com/apache/streampark/commits?author=${NEW_COMMITTER_NAME}
```

Note that, Voting ends one week from today, i.e.
Expand Down
4 changes: 2 additions & 2 deletions community/contribution_guide/new_pmc_member_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ This is a formal vote about inviting ${NEW_PMC_NAME} as our new PMC member.
${Work list}[1]
[1] https://github.com/apache/incubator-streampark/commits?author=${NEW_PMC_NAME}
[1] https://github.com/apache/streampark/commits?author=${NEW_PMC_NAME}
```

Note that, Voting ends one week from today, i.e. [midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD)
Expand Down Expand Up @@ -281,5 +281,5 @@ submission process. This should enable better productivity.
A PPMC member helps manage and guide the direction of the project.
Thanks,
On behalf of the Apache StreamPark (Incubating) PPMC
On behalf of the Apache StreamPark PPMC
```
6 changes: 3 additions & 3 deletions community/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ If you email us with a code snippet, make sure that:

## 🤝 Contribution

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/apache/incubator-streampark/pulls)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/apache/streampark/pulls)

### 🙋 Submit Pull Request and Issues

You can submit any ideas as [pull requests](https://github.com/apache/incubator-streampark/pulls) or as [GitHub issues](https://github.com/apache/incubator-streampark/issues/new/choose).
You can submit any ideas as [pull requests](https://github.com/apache/streampark/pulls) or as [GitHub issues](https://github.com/apache/streampark/issues/new/choose).

> If you're new to posting issues, we ask that you read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) (**This guide does not provide actual support services for this project!**), [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) prior to posting. Well written bug reports help us help you!
Expand All @@ -63,4 +63,4 @@ We welcome your suggestions, comments (including criticisms), comments and contr

Thank you to all the people who already contributed to StreamPark!

[![contrib graph](https://contrib.rocks/image?repo=apache/streampark)](https://github.com/apache/incubator-streampark/graphs/contributors)
[![contrib graph](https://contrib.rocks/image?repo=apache/streampark)](https://github.com/apache/streampark/graphs/contributors)
6 changes: 3 additions & 3 deletions community/maturity.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The following table is filled according to the [Apache Maturity Model](https://c

| **ID** | **Description** | **Status** |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **LC10** | The Apache License, version 2.0, covers the released code. | **YES** The [LICENSE](https://github.com/apache/incubator-streampark/blob/dev/LICENSE) is in GitHub repository. And all source files are with APLv2 header. |
| **LC10** | The Apache License, version 2.0, covers the released code. | **YES** The [LICENSE](https://github.com/apache/streampark/blob/dev/LICENSE) is in GitHub repository. And all source files are with APLv2 header. |
| **LC20** | Libraries that are mandatory dependencies of the project's code do not create more restrictions than the Apache License does. | **YES** All dependencies are listed. |
| **LC30** | The libraries mentioned in LC20 are available as Open Source software. | **YES** All dependencies are listed are available as Open Source software |
| **LC40** | Committers are bound by an Individual Contributor Agreement (the "Apache iCLA") that defines which code they may commit and how they need to identify code that is not their own. | **YES** All committers have iCLAs. |
Expand All @@ -52,7 +52,7 @@ The following table is filled according to the [Apache Maturity Model](https://c

| **ID** | **Description** | **Status** |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **QU10** | The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated. | **YES** We encourage user to [report issues](https://github.com/apache/incubator-streampark/issues). |
| **QU10** | The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated. | **YES** We encourage user to [report issues](https://github.com/apache/streampark/issues). |
| **QU20** | The project puts a very high priority on producing secure software. | **YES** We will promptly confirm any security issues. Currently, All reported security issues have been resolved. |
| **QU30** | The project provides a well-documented, secure and private channel to report security issues, along with a documented way of responding to them. | **Yes** Yes The official website provides a [Security page](https://streampark.apache.org/community/security) |
| **QU40** | The project puts a high priority on backwards compatibility and aims to document any incompatible changes and provide tools and documentation to help users transition to new features. | **Yes** We follow semantic versions. As long as it's within one major version, it's backward compatible. And when any breaking changes added, we provide corresponding upgrade guides. |
Expand All @@ -68,7 +68,7 @@ The following table is filled according to the [Apache Maturity Model](https://c
| **CO40** | The community strives to be meritocratic and gives more rights and responsibilities to contributors who, over time, add value to the project. | **YES** The community has elected 2 new PPMC members and 8 new committers so far. |
| **CO50** | The project documents how contributors can earn more rights such as commit access or decision power, and applies these principles consistently. | **YES** The community has clear docs on [nominatin committers](https://streampark.apache.org/community/contribution_guide/become_committer) and PPMC members. |
| **CO60** | The community operates based on consensus of its members (see CS10) who have decision power. Dictators, benevolent or not, are not welcome in Apache projects. | **YES** All decisions are made after vote by community members. |
| **CO70** | The project strives to answer user questions in a timely manner. | **YES** We use [email protected], [GitHub issue](https://github.com/apache/incubator-streampark/issues) and [GitHub discussion](https://github.com/apache/incubator-streampark/discussions) to do this in a timely manner. |
| **CO70** | The project strives to answer user questions in a timely manner. | **YES** We use [email protected], [GitHub issue](https://github.com/apache/streampark/issues) and [GitHub discussion](https://github.com/apache/streampark/discussions) to do this in a timely manner. |

### Consensus

Expand Down
Loading

0 comments on commit 63b94a6

Please sign in to comment.