From 36ce108173d452bf4b8ea092b806798349d8e8d3 Mon Sep 17 00:00:00 2001 From: benjobs Date: Mon, 18 Nov 2024 20:16:31 +0800 Subject: [PATCH] [Improve] Provide Maturity Assessment for Apache StreamPark (#416) * [Improve] Provide Maturity Assessment for Apache StreamPark * [Improve] maturity minor issue fixed. --- community/contribution_guide/_category_.json | 2 +- community/index.mdx | 66 ++++++++++++++ community/maturity.md | 88 +++++++++++++++++++ ...ion-2.1.x.md => How-to-release-version.md} | 4 +- community/release/_category_.json | 2 +- community/security.md | 13 +++ community/submit_guide/_category_.json | 2 +- docusaurus.config.js | 55 +----------- 8 files changed, 176 insertions(+), 56 deletions(-) create mode 100644 community/index.mdx create mode 100644 community/maturity.md rename community/release/{How-to-release-version-2.1.x.md => How-to-release-version.md} (99%) create mode 100644 community/security.md diff --git a/community/contribution_guide/_category_.json b/community/contribution_guide/_category_.json index 8334e8978..8ed35d6ca 100644 --- a/community/contribution_guide/_category_.json +++ b/community/contribution_guide/_category_.json @@ -1,4 +1,4 @@ { "label": "Contribution Guide", - "position": 1 + "position": 2 } diff --git a/community/index.mdx b/community/index.mdx new file mode 100644 index 000000000..62ef7e524 --- /dev/null +++ b/community/index.mdx @@ -0,0 +1,66 @@ +--- +id: community +title: Community +sidebar_position: 1 +--- + + + + + +Welcome to the Apache StreamPark™ community! + +Every volunteer project obtains its strength from the people involved in it. We invite you to participate as much or as little as you choose. + +You can: + +* Use our project and provide feedback. +* Provide us with the use-cases. +* Report bugs and submit patches. +* Contribute code, documentation. + +## Mailing list + +| Name | Desc | Subscribe | Unsubscribe | Post | Archive | +|----------------------------|---------------------------------|----------------------------------------------------------|--------------------------------------------------------------|----------------------------------------|--------------------------------------------------------------------------| +| dev@streampark.apache.org | Development related discussions | [Subscribe](mailto:dev-subscribe@streampark.apache.org) | [Unsubscribe](mailto:dev-unsubscribe@streampark.apache.org) | [Post](mailto:dev@streampark.apache.org) | [Archive](https://lists.apache.org/list.html?dev@streampark.apache.org) | +| commits@streampark.apache.org | All commits to our repositories | [Subscribe](mailto:commits-subscribe@streampark.apache.org) | [Unsubscribe](mailto:commits-unsubscribe@streampark.apache.org) | Read only list | [Archive](https://lists.apache.org/list.html?commits@streampark.apache.org) | + + +Please make sure you are subscribed to the mailing list you are posting to! + +If you are not subscribed to the mailing list, your message will either be rejected or you won't receive the response. + +### How to subscribe to a mailing list + +Before you can post a message to a mailing list, you need to subscribe to the list first. + +1. Send an email without any contents or subject to listname-subscribe@streampark.apache.org. (replace listname with dev or user) +2. Wait till you receive an email with the subject "confirm subscribe to listname@streampark.apache.org". Reply to that email, without editing the subject or including any contents. +3. Wait till you receive an email with the subject "WELCOME to listname@streampark.apache.org". + +If you email us with a code snippet, make sure that: + +* you do not link to files in external services as such files can change, get deleted or the link might break and thus make an archived email thread useless +* you paste text instead of screenshots of text +* you keep formatting when pasting code to keep the code readable +* there are enough import statements to avoid ambiguities + + +## 🤝 Contribution + +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/apache/incubator-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). + +> 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! + +### 🍻 How to Contribute + +We welcome your suggestions, comments (including criticisms), comments and contributions. See 🔗[How to Contribute](/community/submit_guide/submit_code) and 🔗[Code Submission Guide](/community/submit_guide/submit_code) + +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) diff --git a/community/maturity.md b/community/maturity.md new file mode 100644 index 000000000..d0b472f92 --- /dev/null +++ b/community/maturity.md @@ -0,0 +1,88 @@ +--- +id: 'maturity' +title: 'Maturity' +sidebar_position: 5 +--- + +# Maturity Assessment for Apache StreamPark™ + +The goals of this maturity model are to describe how Apache projects operate in a concise and high-level way, and to provide a basic framework that projects may choose to use to evaluate themselves. + +More details can be found [here](https://community.apache.org/apache-way/apache-project-maturity-model.html). + +## Status of this assessment + +This assessment is still working in progress. + +## Maturity model assessment + +The following table is filled according to the [Apache Maturity Model](https://community.apache.org/apache-way/apache-project-maturity-model.html). Mentors and community members are welcome to comment and modify it. + +### CODE + +| **ID** | **Description** | **Status** | +| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **CD10** | The project produces Open Source software for distribution to the public, at no charge. | **YES** The project source code is licensed under the `Apache License 2.0`. | +| **CD20** | Anyone can easily discover and access the project's code.. | **YES** The [official website](https://streampark.apache.org/) includes `GitHub` link which can access the project's repository on GitHub directly. | +| **CD30** | Anyone using standard, widely-available tools, can build the code in a reproducible way. | **YES** Apache StreamPark provide `build.sh` script, which can quickly build the project). | +| **CD40** | The full history of the project's code is available via a source code control system, in a way that allows anyone to recreate any released version. | **YES** Anyone can view the full history of the project via commit logs. | +| **CD50** | The source code control system establishes the provenance of each line of code in a reliable way, based on strong authentication of the committer. When third parties contribute code, commit messages provide reliable information about the code provenance. | **YES** The project uses GitHub and managed by Apache Infra, it ensuring provenance of each line of code to a committer. And the third-party contributions are accepted in accordance with the contributing guides. | + +### LICENSE + +| **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. | +| **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. | +| **LC50** | The project clearly defines and documents the copyright ownership of everything that the project produces. | **YES** And all source files are with APLv2 header, checked by [license-eye](https://github.com/apache/skywalking-eyes) | + +### Releases + +| **ID** | **Description** | **Status** | +| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **RE10** | Releases consist of source code, distributed using standard and open archive formats that are expected to stay readable in the long term. | **YES** Source release is distributed via [dist.apache.org](https://dist.apache.org/repos/dist/release/incubator/streampark/) and linked from [download page](https://streampark.apache.org/download/). | +| **RE20** | The project's PPMC (Project Management Committee, see CS10) approves each software release in order to make the release an act of the Foundation. | **YES** All releases have been voted at dev@streampark.apache.org and general@incubator.apache.org, and have at least 3 PPMC member's votes. | +| **RE30** | Releases are signed and/or distributed along with digests that anyone can reliably use to validate the downloaded archives. | **YES** All releases are signed, and the [KEYS](https://dist.apache.org/repos/dist/release/incubator/streampark/KEYS) are available. | +| **RE40** | The project can distribute convenience binaries alongside source code, but they are not Apache Releases, they are provided with no guarantee. | **YES** User can easily build binaries from source code, The release of the official version follows the Apache License policy and is completed by a (P)PMC vote. | +| **RE50** | The project documents a repeatable release process so that someone new to the project can independently generate the complete set of artifacts required for a release. | **YES** We can follow the [Release guide](https://streampark.apache.org/community/release/how_to_release_version) to make a new Apache StreamPark release, and so far we had 6 different release managers. | + +### Quality + +| **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). | +| **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. | +| **QU50** | The project strives to respond to documented bug reports in a timely manner. | **YES** The project has resolved 1000+ issues and 2300+ pull requests so far, with very prompt response. | + +### Community + +| **ID** | **Description** | **Status** | +| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **CO10** | The project has a well-known homepage that points to all the information required to operate according to this maturity model. | **YES** The [official website](https://streampark.apache.org/) includes all information user need to run Apache StreamPark. | +| **CO20** | The community welcomes contributions from anyone who acts in good faith and in a respectful manner, and who adds value to the project. | **Yes** We provide [Contribution Guide](https://streampark.apache.org/community/contribution_guide/mailing_lists/) and [code style](https://streampark.apache.org/community/submit_guide/code_style_and_quality_guide). And we also have a [StreamPark Improvement Proposals (SPIPs)](https://streampark.apache.org/community/contribution_guide/SPIP) | +| **CO30** | Contributions include source code, documentation, constructive bug reports, constructive discussions, marketing and generally anything that adds value to the project. | **YES** All good contributions including code and non-code are welcomed. | +| **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 dev@streampark.apache.org, [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. | + +### Consensus + +| **ID** | **Description** | **Status** | +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |---------------------------------------------------------------------------------------------------------------| +| **CS10** | The project maintains a public list of its contributors who have decision power. The project's PPMC (Project Management Committee) consists of those contributors. | **Yes** See [team](https://streampark.apache.org/team) with all PPMC members and committers. | +| **CS20** | Decisions require a consensus among PPMC members and are documented on the project's main communications channel. The PPMC takes community opinions into account, but the PPMC has the final word. | **YES** All decisions are made by votes on dev@streampark.apache.org, and with at least 3 +1 votes from PPMC. | +| **CS30** | The project uses documented voting rules to build consensus when discussion is not sufficient. | **YES** The project uses the standard ASF voting rules. | +| **CS40** | In Apache projects, vetoes are only valid for code commits. The person exercising the veto must justify it with a technical explanation, as per the Apache voting rules defined in CS30. | **YES** Apache StreamPark community has not used the veto power yet except for code commits. | +| **CS50** | All "important" discussions happen asynchronously in written form on the project's main communications channel. Offline, face-to-face or private discussions that affect the project are also documented on that channel. | **YES** All important discussions and conclusions are recorded in written form. | + +### Independence + +| **ID** | **Description** | **Status** | +| -------- | ---------------------------------------------------------------------------------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **IN10** | The project is independent from any corporate or organizational influence. | **YES** The PPMC members and committer of Apache StreamPark are from several different companies, and majority of them are NOT From the company that donated this project. | +| **IN20** | Contributors act as themselves, not as representatives of a corporation or organization. | **YES** The contributors act on their own initiative without representing a corporation or organization. | diff --git a/community/release/How-to-release-version-2.1.x.md b/community/release/How-to-release-version.md similarity index 99% rename from community/release/How-to-release-version-2.1.x.md rename to community/release/How-to-release-version.md index c6f29d9e5..68058179b 100644 --- a/community/release/How-to-release-version-2.1.x.md +++ b/community/release/How-to-release-version.md @@ -1,6 +1,6 @@ --- -id: 'how_to_release_version_2.1.x' -title: How to Release Version 2.1.x +id: 'how_to_release_version' +title: How to Release Version sidebar_position: 4 --- diff --git a/community/release/_category_.json b/community/release/_category_.json index 5141b1a41..c1b4cdf17 100644 --- a/community/release/_category_.json +++ b/community/release/_category_.json @@ -1,4 +1,4 @@ { "label": "Release", - "position": 3 + "position": 4 } diff --git a/community/security.md b/community/security.md new file mode 100644 index 000000000..599d30565 --- /dev/null +++ b/community/security.md @@ -0,0 +1,13 @@ +--- +id: 'security' +title: 'Security' +sidebar_position: 4 +--- + +If you have any concerns regarding StreamPark's security, or you discover a vulnerability or potential threat, please do not hesitate to get in touch with the Apache Security Team by dropping an email at private@streampark.apache.org. + +Please specify the project name as "StreamPark" in the email, and provide a description of the relevant problem or potential threat. You are also urged to recommend how to reproduce and replicate the issue. + +The Apache Security Team and the StreamPark community will get back to you after assessing and analyzing the findings. + +Please note that the security issue should be reported on the security email first, before disclosing it on any public domain. diff --git a/community/submit_guide/_category_.json b/community/submit_guide/_category_.json index 8ce788731..c627aebf0 100644 --- a/community/submit_guide/_category_.json +++ b/community/submit_guide/_category_.json @@ -1,4 +1,4 @@ { "label": "Submit Guide", - "position": 2 + "position": 3 } diff --git a/docusaurus.config.js b/docusaurus.config.js index 3a36dd501..86f5ad35c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -124,58 +124,11 @@ const config = { activeBaseRegex: '/download', }, { + type: 'doc', + docId: 'community', + position: 'right', label: 'Community', - position: "right", - items: [ - { - label: "Code of conduct", - to: "https://www.apache.org/foundation/policies/conduct", - }, - { - label: "Join the mailing lists", - to: "/community/contribution_guide/mailing_lists", - }, - { - label: "Become A Committer", - to: "/community/contribution_guide/become_committer", - }, - { - label: "Become A PMC member", - to: "/community/contribution_guide/become_pmc_member", - }, - { - label: "New Committer Process", - to: "/community/contribution_guide/new_committer_process", - }, - { - label: "New PMC Member Process", - to: "/community/contribution_guide/new_pmc_ember_process", - }, - { - label: "Documentation Notice", - to: "/community/submit_guide/document", - }, - { - label: "Submit Code", - to: "/community/submit_guide/submit_code", - }, - { - label: "Code style and quality guide", - to: "/community/submit_guide/code_style_and_quality_guide", - }, - { - label: "Documentation style guide", - to: "/community/submit_guide/documentation_style_guide", - }, - { - label: "How to release version 2.1.x", - to: "/community/release/how_to_release_version_2.1.x", - }, - { - label: "How to Verify Release", - to: "/community/release/how_to_verify_release", - }, - ], + docsPluginId: 'community' }, { to: '/team',