[Improve] Provide Maturity Assessment for Apache StreamPark (#416)

* [Improve] Provide Maturity Assessment for Apache StreamPark * [Improve] maturity minor issue fixed.
apache · Nov 18, 2024 · 36ce108 · 36ce108
1 parent 858a69d
commit 36ce108
Show file tree

Hide file tree

Showing 8 changed files with 176 additions and 56 deletions.
diff --git 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
@@ -0,0 +1,66 @@
+---
+id: community
+title: Community
+sidebar_position: 1
+---
+
+<head>
+  <meta httpEquiv="Content-Security-Policy" content="frame-src https://calendar.google.com/"/>
+</head>
+
+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                                                                  |
+|----------------------------|---------------------------------|----------------------------------------------------------|--------------------------------------------------------------|----------------------------------------|--------------------------------------------------------------------------|
+| [email protected]     | Development related discussions | [Subscribe](mailto:[email protected])     | [Unsubscribe](mailto:[email protected])     | [Post](mailto:[email protected])  | [Archive](https://lists.apache.org/[email protected])     |
+| [email protected] | All commits to our repositories | [Subscribe](mailto:[email protected]) | [Unsubscribe](mailto:[email protected]) | Read only list                         | [Archive](https://lists.apache.org/[email protected]) |
+
+
+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 [email protected]. (replace listname with dev or user)
+2. Wait till you receive an email with the subject "confirm subscribe to [email protected]". Reply to that email, without editing the subject or including any contents.
+3. Wait till you receive an email with the subject "WELCOME to [email protected]".
+
+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
diff --git a/...y/release/How-to-release-version-2.1.x.md → community/release/How-to-release-version.md b/...y/release/How-to-release-version-2.1.x.md → 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
@@ -1,4 +1,4 @@
 {
   "label": "Release",
-  "position": 3
+  "position": 4
 }
diff --git a/community/security.md 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 [email protected].
+
+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
@@ -1,4 +1,4 @@
 {
   "label": "Submit Guide",
-  "position": 2
+  "position": 3
 }
diff --git 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',