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-website.git
The following commit(s) were added to refs/heads/dev by this push:
new c25a4e5 Add Community (#136)
c25a4e5 is described below
commit c25a4e57b71664e7e847d45bf17870fd6837ea2a
Author: ChunFu Wu <[email protected]>
AuthorDate: Mon Sep 19 08:43:03 2022 +0800
Add Community (#136)
---
community/contribution_guide/_category_.json | 4 +
community/contribution_guide/become_committer.md | 84 ++++++
community/contribution_guide/become_pmc_member.md | 84 ++++++
community/contribution_guide/mailing_lists.md | 60 +++++
.../contribution_guide/new_committer_process.md | 245 ++++++++++++++++++
.../contribution_guide/new_pmc_member_process.md | 285 +++++++++++++++++++++
community/submit_guide/_category_.json | 2 +-
community/submit_guide/document.md | 45 +++-
community/submit_guide/submit-code.md | 26 +-
docusaurus.config.js | 38 +++
yarn.lock | 12 -
11 files changed, 856 insertions(+), 29 deletions(-)
diff --git a/community/contribution_guide/_category_.json
b/community/contribution_guide/_category_.json
new file mode 100644
index 0000000..8334e89
--- /dev/null
+++ b/community/contribution_guide/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Contribution Guide",
+ "position": 1
+}
diff --git a/community/contribution_guide/become_committer.md
b/community/contribution_guide/become_committer.md
new file mode 100644
index 0000000..71e0a3a
--- /dev/null
+++ b/community/contribution_guide/become_committer.md
@@ -0,0 +1,84 @@
+---
+id: 'become_committer'
+title: 'Become A Committer'
+sidebar_position: 2
+---
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+## Become A Committer of Apache StreamPark
+
+Anyone being supportive of the community and working in any of the
+CoPDoC areas can become an Apache StreamPark committer. The CoPDoC is an
+acronym from ASF to describe how we recognize your contributions not
+only by code.
+
+- **Co**mmunity - You can join us via our mailing list, issue
+ trackers, discussions page to interact with community members, and
+ share vision and knowledge
+- **P**roject - a clear vision and consensus are needed
+- **Do**cumentation - without it, the stuff remains only in the minds
+ of the authors
+- **C**ode - discussion goes nowhere without code
+
+Apache StreamPark community strives to be meritocratic. Thus, once someone
+has contributed sufficiently to any area of CoPDoC they can be a
+candidate for committer-ship and at last voted in as a StreamPark
+committer. Being an Apache StreamPark committer does not necessarily mean
+you must commit code with your commit privilege to the codebase; it
+means you are committed to the StreamPark project and are productively
+contributing to our community's success.
+
+## Committer requirements:
+
+There are no strict rules for becoming a committer or PPMC member.
+Candidates for new committers are typically people that are active
+contributors and community members. Anyway, if the rules can be
+clarified a little bit, it can somehow clear the doubts in the minds
+of contributors and make the community more transparent, reasonable,
+and fair.
+
+### Continuous contributions
+
+Committer candidates should have a decent amount of continuous
+engagements and contributions (fixing bugs, adding new features,
+writing documentation, maintaining issues boards, code review, or answering
+community questions) to StreamParkStreamPark either by contributing to the
codebase
+of the main website or StreamPark's GitHub repositories.
+
+- +3 months with light activity and engagement.
+- +2 months of medium activity and engagement.
+- +1 month with solid activity and engagement.
+
+### Quality of contributions
+- A solid general understanding of the project
+- Well tested, well-designed, following Apache StreamPark coding
+ standards, and simple patches.
+- Well-organized and detailed user-oriented documentation.
+
+### Community involvement
+
+- Be active, courteous, and respectful on the dev mailing list and
+ help mentor newer contributors
+ and users.
+- Be active, courteous, and respectful on the issue tracker for
+ project maintenance
+- Be active, courteous, and respectful for pull requests reviewing
+- Be involved in the design road map discussions with a professional
+ and diplomatic approach even if there is a disagreement
+- Promoting the project by writing articles or holding events
diff --git a/community/contribution_guide/become_pmc_member.md
b/community/contribution_guide/become_pmc_member.md
new file mode 100644
index 0000000..9713d2b
--- /dev/null
+++ b/community/contribution_guide/become_pmc_member.md
@@ -0,0 +1,84 @@
+---
+id: 'become_pmc_member'
+title: 'Become A PMC member'
+sidebar_position: 3
+---
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+## Become A PMC member of Apache StreamPark
+
+Anyone being supportive of the community and working in any of the
+CoPDoC areas can become an Apache StreamPark PMC member. The CoPDoC is an
+acronym from ASF to describe how we recognize your contributions not
+only by code.
+
+- **Co**mmunity - You can join us via our mailing list, issue
+ trackers, discussions page to interact with community members, and
+ share vision and knowledge
+- **P**roject - a clear vision and consensus are needed
+- **Do**cumentation - without it, the stuff remains only in the minds
+ of the authors
+- **C**ode - discussion goes nowhere without code
+
+Apache StreamPark community strives to be meritocratic. Thus, once someone
+has contributed sufficiently to any area of CoPDoC they can be a
+candidate for PMC membership and at last voted in as a StreamPark
+PMC member. Being an Apache StreamPark PMC member does not necessarily mean
+you must commit code with your commit privilege to the codebase; it
+means you are committed to the StreamPark project and are productively
+contributing to our community's success.
+
+## PMC member requirements:
+
+There are no strict rules for becoming a committer or PPMC member.
+Candidates for new PMC member are typically people that are active
+contributors and community members. Anyway, if the rules can be
+clarified a little bit, it can somehow clear the doubts in the minds
+of contributors and make the community more transparent, reasonable,
+and fair.
+
+### Continuous contributions
+
+PMC member candidates should have a decent amount of continuous
+engagements and contributions (fixing bugs, adding new features,
+writing documentation, maintaining issues boards, code review, or answering
+community questions) to StreamPark either by contributing to the codebase
+of the main website or StreamPark's GitHub repositories.
+
+- +3 months with light activity and engagement.
+- +4 months of medium activity and engagement.
+- +5 month with solid activity and engagement.
+
+### Quality of contributions
+- A solid general understanding of the project
+- Well tested, well-designed, following Apache StreamPark coding
+ standards, and simple patches.
+- Well-organized and detailed user-oriented documentation.
+
+### Community involvement
+
+- Be active, courteous, and respectful on the dev mailing list and
+ help mentor newer contributors
+ and users.
+- Be active, courteous, and respectful on the issue tracker for
+ project maintenance
+- Be active, courteous, and respectful for pull requests reviewing
+- Be involved in the design road map discussions with a professional
+ and diplomatic approach even if there is a disagreement
+- Promoting the project by writing articles or holding events
diff --git a/community/contribution_guide/mailing_lists.md
b/community/contribution_guide/mailing_lists.md
new file mode 100644
index 0000000..3f6affc
--- /dev/null
+++ b/community/contribution_guide/mailing_lists.md
@@ -0,0 +1,60 @@
+---
+id: 'mailing_lists'
+title: 'Mailing Lists'
+sidebar_position: 1
+---
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+The StreamPark developer mailing list is the preferred means for all your
questions when using StreamPark, which pushes your doubts out to the entire
community.
+This is the best way to keep up-to-date with the community.
+
+Before you post anything to the mailing lists, be sure that you already
**subscribe** to them.
+The currently available lists are listed in the below table.
+
+## Usages
+
+### Developer List
+
+- Use this list for your StreamPark questions
+- Used by StreamPark contributors to discuss development of StreamPark
+
+### Commits List
+
+- Notifications on changes to the StreamPark codebase
+
+| List Name | Address | Subscribe
| Unsubscribe
| Archive
|
+|---------------------|------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------|-----------------------------------------------------------------------------|
+| **Developer List** | [email protected] |
[subscribe](mailto:[email protected]) |
[unsubscribe](mailto:[email protected]) |
[archive](https://lists.apache.org/[email protected]) |
+| **Commits List** | [email protected] |
[subscribe](mailto:[email protected]) |
[unsubscribe](mailto:[email protected]) |
[archive](https://lists.apache.org/[email protected]) |
+
+## Steps for Subscription
+
+Sending a subscription email is also very simple. The steps are as follows:
+
+- 1、**Subscribe**: Click the **subscribe** button in the above table, and it
redirects to your mail client. The subject and content are arbitrary.
+ After that, you will receive a confirmation email from
[email protected] (if not received, please confirm whether the
email is automatically classified as SPAM, promotion email, subscription email,
etc.).
+- 2、**Confirm**: Reply directly to the confirmation email, or click on the
link in the email to reply quickly. The subject and content are arbitrary.
+- 3、**Welcome**: After completing the above steps, you will receive a welcome
email with the subject WELCOME to [email protected], and you have
successfully subscribed to the Apache StreamPark mailing list.
+
+## Post Plain Text Mails
+
+When posting to the mailing lists, please use plain text emails.
+**Do not use HTML emails**.
+HTML emails are more likely to be targeted as spam mails and rejected.
+It may get malformed through different mail clients and not easily readable by
others.
diff --git a/community/contribution_guide/new_committer_process.md
b/community/contribution_guide/new_committer_process.md
new file mode 100644
index 0000000..4baadf7
--- /dev/null
+++ b/community/contribution_guide/new_committer_process.md
@@ -0,0 +1,245 @@
+---
+id: 'new_committer_process'
+title: 'New Committer Process'
+sidebar_position: 4
+---
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+This guideline is based on [apache
newcommitter](https://community.apache.org/newcommitter.html#new-committer-process)
+
+## The process of new Committer
+
+- Call a vote in mailing `[email protected]`
+
+ see **Committer Vote Template**
+
+- Close the vote
+
+ see **Close Vote Template**
+
+- If the result is positive, invite the new committer
+
+ see **Committer Invite Template**
+
+- If accept, then: Accept the committer
+
+ see **Committer Accept Template**
+
+- Wait until we see that receipt of CLA is recorded
+
+- Request creation of the committer account
+
+ see **Committer Account Creation**
+
+ - Wait until root says it is done
+ - PMC Chair enables svn and other access
+ - Add committer to the appropriate groups in JIRA and CWiki
+
+- Notify the committer of completion
+
+ see **Committer Done Template**
+
+## Template
+
+Note that, there are three placeholder in template should be replaced before
using
+
+- NEW_COMMITTER_NAME
+- NEW_COMMITTER_EMAIL
+- NEW_COMMITTER_APACHE_NAME
+
+### Committer Vote Template
+
+```text
+To: [email protected]
+Subject: [VOTE] New committer: ${NEW_COMMITTER_NAME}
+```
+
+```text
+Hi StreamPark PPMC,
+
+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}
+```
+
+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)
+See voting [guidelines](https://community.apache.org/newcommitter.html)
+
+### Close Vote Template
+
+```text
+To: [email protected]
+Subject: [RESULT] [VOTE] New committer: ${NEW_COMMITTER_NAME}
+```
+
+```text
+Hi StreamPark PPMC,
+
+The vote has now closed. The results are:
+
+Binding Votes:
+
++1 [TOTAL BINDING +1 VOTES]
+ 0 [TOTAL BINDING +0/-0 VOTES]
+-1 [TOTAL BINDING -1 VOTES]
+
+The vote is ***successful/not successful***
+```
+
+### Committer Invite Template
+
+```text
+To: ${NEW_COMMITTER_EMAIL}
+Cc: [email protected]
+Subject: Invitation to become StreamPark committer: ${NEW_COMMITTER_NAME}
+```
+
+```text
+Hello ${NEW_COMMITTER_NAME},
+
+The StreamPark Project Management Committee (PMC)
+hereby offers you committer privileges to the project.
+These privileges are offered on the understanding that
+you'll use them reasonably and with common sense.
+We like to work on trust rather than unnecessary constraints.
+
+Being a committer enables you to more easily make
+changes without needing to go through the patch
+submission process.
+
+Being a committer does not require you to
+participate any more than you already do. It does
+tend to make one even more committed. You will
+probably find that you spend more time here.
+
+Of course, you can decline and instead remain as a
+contributor, participating as you do now.
+
+A. This personal invitation is a chance for you to
+accept or decline in private. Either way, please
+let us know in reply to the [email protected]
+address only.
+
+B. If you accept, the next step is to register an iCLA:
+ 1. Details of the iCLA and the forms are found
+ through this link: https://www.apache.org/licenses/#clas
+
+ 2. Instructions for its completion and return to
+ the Secretary of the ASF are found at
+ https://www.apache.org/licenses/#submitting
+
+ 3. When you transmit the completed iCLA, request
+ to notify the Apache StreamPark and choose a
+ unique Apache ID. Look to see if your preferred
+ ID is already taken at
+ https://people.apache.org/committer-index.html
+ This will allow the Secretary to notify the PMC
+ when your iCLA has been recorded.
+
+When recording of your iCLA is noted, you will
+receive a follow-up message with the next steps for
+establishing you as a committer.
+```
+
+### Committer Accept Template
+
+```text
+To: ${NEW_COMMITTER_EMAIL}
+Cc: [email protected]
+Subject: Re: invitation to become StreamPark committer
+```
+
+```text
+Welcome. Here are the next steps in becoming a project committer. After that
+we will make an announcement to the [email protected] list.
+
+You need to send a Contributor License Agreement to the ASF.
+Normally you would send an Individual CLA. If you also make
+contributions done in work time or using work resources,
+see the Corporate CLA. Ask us if you have any issues.
+https://www.apache.org/licenses/#clas.
+
+You need to choose a preferred ASF user name and alternatives.
+In order to ensure it is available you can view a list of taken IDs at
+https://people.apache.org/committer-index.html
+
+Please notify us when you have submitted the CLA and by what means
+you did so. This will enable us to monitor its progress.
+
+We will arrange for your Apache user account when the CLA has
+been recorded.
+
+After that is done, please make followup replies to the
[email protected] list.
+We generally discuss everything there and keep the
[email protected] list for occasional matters which must be
private.
+
+The developer section of the website describes roles within the ASF and
provides other
+resources:
+ https://www.apache.org/foundation/how-it-works.html
+ https://www.apache.org/dev/
+
+The incubator also has some useful information for new committers
+in incubating projects:
+ https://incubator.apache.org/guides/committer.html
+ https://incubator.apache.org/guides/ppmc.html
+
+Just as before you became a committer, participation in any ASF community
+requires adherence to the ASF Code of Conduct:
+ https://www.apache.org/foundation/policies/conduct.html
+
+Yours,
+The Apache StreamPark PPMC
+```
+
+### Committer Done Template
+
+```text
+To: [email protected], ${NEW_COMMITTER_EMAIL}
+Subject: account request: ${NEW_COMMITTER_NAME}
+```
+
+```text
+${NEW_COMMITTER_NAME}, as you know, the ASF Infrastructure has set up your
+committer account with the username '${NEW_COMMITTER_APACHE_NAME}'.
+
+Please follow the instructions to set up your SSH,
+svn password, svn configuration, email forwarding, etc.
+https://www.apache.org/dev/#committers
+
+You have commit access to specific sections of the
+ASF repository, as follows:
+
+The general "committers" at:
+ https://svn.apache.org/repos/private/committers
+
+If you have any questions during this phase, then please
+see the following resources:
+
+Apache developer's pages: https://www.apache.org/dev/
+Incubator committer guide: https://incubator.apache.org/guides/committer.html
+
+Naturally, if you don't understand anything be sure to ask us on the
[email protected] mailing list.
+Documentation is maintained by volunteers and hence can be out-of-date and
incomplete - of course
+you can now help fix that.
+
+A PPMC member will announce your election to the dev list soon.
+```
diff --git a/community/contribution_guide/new_pmc_member_process.md
b/community/contribution_guide/new_pmc_member_process.md
new file mode 100644
index 0000000..9828d0f
--- /dev/null
+++ b/community/contribution_guide/new_pmc_member_process.md
@@ -0,0 +1,285 @@
+---
+id: 'new_pmc_ember_process'
+title: 'New PMC Member Process'
+sidebar_position: 5
+---
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+This guideline is based on [apache
newcommitter](https://community.apache.org/newcommitter.html#new-committer-process)
+
+## The process of new PMC member
+
+- Call a vote in mailing `[email protected]`
+
+ see **PMC Member Vote Template**
+
+- Close the vote
+
+ see **Close Vote Template**
+
+- Board Approval of new PMC member
+
+ see **Board Approval of new PMC member**
+
+- If the result is positive, invite the new PMC member
+
+ see **PMC member Invite Template**
+
+- If accept, then: Accept the PMC member
+
+ see **PMC Member Accept Template**
+
+- Notify the PMC member of completion
+
+ see **PMC Member Done Template**
+
+- Announce the new PMC member
+
+ see **PMC Member Announce Template**
+
+## Template
+
+Note that, there are three placeholder in template should be replaced before
using
+
+- NEW_PMC_NAME
+- NEW_PMC_EMAIL
+- NEW_PMC_APACHE_NAME
+
+### PMC Member Vote Template
+
+```text
+To: [email protected]
+Subject: [VOTE] New PMC member candidate: ${NEW_PMC_NAME}
+```
+
+```text
+Hi StreamPark PPMC,
+
+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}
+```
+
+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)
+See voting [guidelines](https://community.apache.org/newcommitter.html)
+
+
+### Close Vote Template
+
+```text
+To: [email protected]
+Subject: [RESULT] [VOTE] New PMC member: ${NEW_PMC_NAME}
+```
+
+```text
+Hi StreamPark PPMC,
+
+The vote has now closed. The results are:
+
+Binding Votes:
+
++1 [TOTAL BINDING +1 VOTES]
+ 0 [TOTAL BINDING +0/-0 VOTES]
+-1 [TOTAL BINDING -1 VOTES]
+
+The vote is ***successful/not successful***
+```
+
+### Board Approval of new PMC member Template
+
+```text
+To: [email protected]
+Cc: private@<project>.apache.org
+Subject: [NOTICE] ${NEW_PMC_NAME} for StreamPark PMC member
+```
+
+```text
+StreamPark proposes to invite ${NEW_PMC_NAME} to join the PMC.
+
+The vote result is available here: https://lists.apache.org/...
+```
+
+See [newpmc](https://www.apache.org/dev/pmc.html#newpmc)
+
+### PMC Member Invite Template
+
+```text
+To: ${NEW_PMC_EMAIL}
+Cc: [email protected]
+Subject: Invitation to become StreamPark PMC member: ${NEW_PMC_NAME}
+```
+
+```text
+Hello ${NEW_PMC_NAME},
+
+The StreamPark Project Management Committee (PMC)
+hereby offers you committer privileges to the project
+as well as membership in the PMC.
+These privileges are offered on the understanding that
+you'll use them reasonably and with common sense.
+We like to work on trust rather than unnecessary constraints.
+
+Being a PMC member enables you to guide the direction of the project.
+
+Being a PMC member does not require you to
+participate any more than you already do. It does
+tend to make one even more committed. You will
+probably find that you spend more time here.
+
+Of course, you can decline and instead remain as a
+contributor, participating as you do now.
+
+A. This personal invitation is a chance for you to
+accept or decline in private. Either way, please
+let us know in reply to the [email protected]
+address only.
+
+B. If you accept, the next step is to register an iCLA:
+ 1. Details of the iCLA and the forms are found
+ through this link: https://www.apache.org/licenses/#clas
+
+ 2. Instructions for its completion and return to
+ the Secretary of the ASF are found at
+ https://www.apache.org/licenses/#submitting
+
+ 3. When you transmit the completed iCLA, request
+ to notify the Apache StreamPark and choose a
+ unique Apache ID. Look to see if your preferred
+ ID is already taken at
+ https://people.apache.org/committer-index.html
+ This will allow the Secretary to notify the PMC
+ when your iCLA has been recorded.
+
+When recording of your iCLA is noted, you will
+receive a follow-up message with the next steps for
+establishing you as a PMC member.
+```
+
+### PMC Member Accept Template
+
+```text
+To: ${NEW_PMC_EMAIL}
+Cc: [email protected]
+Subject: Re: invitation to become StreamPark PMC member
+```
+
+```text
+Welcome. Here are the next steps in becoming a project PMC. After that
+we will make an announcement to the [email protected] list.
+
+You need to send a Contributor License Agreement to the ASF.
+Normally you would send an Individual CLA. If you also make
+contributions done in work time or using work resources,
+see the Corporate CLA. Ask us if you have any issues.
+https://www.apache.org/licenses/#clas.
+
+You need to choose a preferred ASF user name and alternatives.
+In order to ensure it is available you can view a list of taken IDs at
+https://people.apache.org/committer-index.html
+
+Please notify us when you have submitted the CLA and by what means
+you did so. This will enable us to monitor its progress.
+
+We will arrange for your Apache user account when the CLA has
+been recorded.
+
+After that is done, please make followup replies to the
[email protected] list.
+We generally discuss everything there and keep the
[email protected] list for occasional matters which must be
private.
+
+The developer section of the website describes roles within the ASF and
provides other
+resources:
+ https://www.apache.org/foundation/how-it-works.html
+ https://www.apache.org/dev/
+
+The incubator also has some useful information for new PMC
+in incubating projects:
+ https://incubator.apache.org/guides/committer.html
+ https://incubator.apache.org/guides/ppmc.html
+
+Just as before you became a PMC member, participation in any ASF community
+requires adherence to the ASF Code of Conduct:
+ https://www.apache.org/foundation/policies/conduct.html
+
+Yours,
+The Apache StreamPark PPMC
+```
+
+### PMC Member Done Template
+
+```text
+To: [email protected], ${NEW_PMC_EMAIL}
+Subject: account request: ${NEW_PMC_NAME}
+```
+
+```text
+${NEW_PMC_EMAIL}, as you know, the ASF Infrastructure has set up your
+committer account with the username '${NEW_PMC_APACHE_NAME}'.
+
+Please follow the instructions to set up your SSH,
+svn password, svn configuration, email forwarding, etc.
+https://www.apache.org/dev/#committers
+
+You have commit access to specific sections of the
+ASF repository, as follows:
+
+The general "committers" at:
+ https://svn.apache.org/repos/private/committers
+
+If you have any questions during this phase, then please
+see the following resources:
+
+Apache developer's pages: https://www.apache.org/dev/
+Incubator committer guide: https://incubator.apache.org/guides/committer.html
+
+Naturally, if you don't understand anything be sure to ask us on the
[email protected] mailing list.
+Documentation is maintained by volunteers and hence can be out-of-date and
incomplete - of course
+you can now help fix that.
+
+A PPMC member will announce your election to the dev list soon.
+```
+
+### PMC Member Announce Template
+
+```text
+To: [email protected]
+[ANNONCE] New PMC member: ${NEW_PMC_NAME}
+```
+
+```text
+Hi StreamPark Community,
+
+The Podling Project Management Committee (PPMC) for Apache StreamPark
+has invited ${NEW_PMC_NAME} to become our PMC member and
+we are pleased to announce that he has accepted.
+
+### add specific details here ###
+
+Please join me in congratulating ${NEW_PMC_NAME}!
+
+Being a committer enables easier contribution to the
+project since there is no need to go via the patch
+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
+```
diff --git a/community/submit_guide/_category_.json
b/community/submit_guide/_category_.json
index 28f7545..8ce7887 100644
--- a/community/submit_guide/_category_.json
+++ b/community/submit_guide/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Submit Guide",
- "position": 1
+ "position": 2
}
diff --git a/community/submit_guide/document.md
b/community/submit_guide/document.md
index e0ebaec..01ad69a 100644
--- a/community/submit_guide/document.md
+++ b/community/submit_guide/document.md
@@ -1,20 +1,36 @@
---
-title: Documentation Notice
+id: 'document'
+title: 'Documentation Notice'
sidebar_position: 1
---
-# Documentation Notice
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
Good documentation is critical for any type of software. Any contribution that
can improve the StreamPark documentation is welcome.
-## Get the document project
+## Get the document project
-Documentation for the StreamPark project is maintained in a separate [git
repository](https://github.com/streamxhub/streamx-website).
+Documentation for the StreamPark project is maintained in a separate [git
repository](https://github.com/apache/incubator-streampark-websitehttps://github.com/apache/incubator-streampark-website).
First you need to fork the document project into your own github repository,
and then clone the document to your local computer.
```shell
-git clone https://github.com/<your-github-user-name>/streamx-website
+git clone
https://github.com/<your-github-user-name>/incubator-streampark-website
```
## Preview and generate static files
@@ -22,13 +38,14 @@ git clone
https://github.com/<your-github-user-name>/streamx-website
This website is compiled using node, using Docusaurus framework components
1. Download and install nodejs (version>12.5.0)
-2. Clone the code to the local `git clone
[email protected]:apache/streamxhub/streamx-website.git`
+2. Clone the code to the local `git clone
[email protected]:apache/incubator-streampark-website.git`
2. Run `npm install` to install the required dependent libraries.
3. Run `npm run start` in the root directory, you can visit
http://localhost:3000 to view the English mode preview of the site
4. Run `npm run start-zh` in the root directory, you can visit
http://localhost:3000 to view the Chinese mode preview of the site
5. To generate static website resource files, run `npm run build`. The static
resources of the build are in the build directory.
## Directory structure
+
```html
|-- community
|-- docs // The next version of the document that will be released soon
@@ -60,7 +77,6 @@ This website is compiled using node, using Docusaurus
framework components
| |-- home // homepage picture
| |-- img // common picture
|-- docusaurus.config.js
-
```
## Specification
@@ -88,10 +104,12 @@ Image resources are unified under `static/{module name}`
css and other style files are placed in the `src/css` directory
### Page content modification
+
> Except for the homepage, team, user, Docs>All Version module page, all other
> pages can be directly jumped to the corresponding github resource
> modification page through the'Edit this page' button at the bottom
### Home page modification
-Visit the page https://streamxhub.com
+
+Visit the page https://streampark.apache.org/
Located in `src/pages/home`
```
@@ -99,17 +117,23 @@ Located in `src/pages/home`
│ languages.json // Home page Chinese and English configuration
│ index.less // homepage style
```
+
### Team page modification
-Visit the page https://streamxhub.com/team
+
+Visit the page https://streampark.apache.org/team
Located in `src/pages/team`
+
```
├─team
│ languages.json
│ index.js
│ index.less
```
+
### User list page modification
-Visit the page https://streamxhub.com/user
+
+Visit the page https://streampark.apache.org/user
+
```
Located in `src/pages/user`
└─versions
@@ -119,4 +143,3 @@ Located in `src/pages/user`
index.less
languages.json
```
-
diff --git a/community/submit_guide/submit-code.md
b/community/submit_guide/submit-code.md
index d11d7f4..e692635 100644
--- a/community/submit_guide/submit-code.md
+++ b/community/submit_guide/submit-code.md
@@ -1,11 +1,27 @@
---
-title: Submit Code
+id: 'submit_code'
+title: 'Submit Code'
sidebar_position: 2
---
-# Submit Code
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
-* First from the remote repository <https://github.com/streamxhub/streamx.git>
fork a copy of the code into your own repository
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+* First from the remote repository
<https://github.com/apache/incubator-streampark.git> fork a copy of the code
into your own repository
* There are currently three branches in the remote repository:
* **dev** daily development branch
@@ -17,13 +33,13 @@ sidebar_position: 2
* Clone your repository to your local
```shell
- git clone [email protected]:streamxhub/streamx.git
+ git clone [email protected]:apache/incubator-streampark.git
```
* Add remote repository address, named upstream
```shell
- git remote add upstream [email protected]:streamxhub/streamx.git
+ git remote add upstream [email protected]:apache/incubator-streampark.git
```
* View repository
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 912c939..7ebb19f 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -78,6 +78,44 @@ const config = {
position: 'right',
activeBaseRegex: `/docs`,
},
+ {
+ 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",
+ },
+ ],
+ },
{
to: '/team',
label: 'Team',
diff --git a/yarn.lock b/yarn.lock
index 7e24b13..a42ba5e 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -6158,13 +6158,6 @@ react-textarea-autosize@^8.3.2:
use-composed-ref "^1.3.0"
use-latest "^1.2.1"
-react-tiny-slider@^1.0.6:
- version "1.0.6"
- resolved
"https://registry.yarnpkg.com/react-tiny-slider/-/react-tiny-slider-1.0.6.tgz#ccc3e571fa24676ba97a54989d47219998d779dc";
- integrity
sha512-A/vMqtQyzBThnVQZDUNA5gVgtx9CDR0oPZd5haEHVI8bg3Z82OHwS7NQ6LmFLdzegftn7VDXbl5Ciyy1X8cL7g==
- dependencies:
- tiny-slider "^2.9.3"
-
react-tsparticles@^2.1.4:
version "2.2.4"
resolved
"https://registry.yarnpkg.com/react-tsparticles/-/react-tsparticles-2.2.4.tgz#37400f4dcf6d28f91ec8ff75e314c03a664d92a5";
@@ -7012,11 +7005,6 @@ tiny-invariant@^1.0.2:
resolved
"https://registry.yarnpkg.com/tiny-invariant/-/tiny-invariant-1.2.0.tgz#a1141f86b672a9148c72e978a19a73b9b94a15a9";
integrity
sha512-1Uhn/aqw5C6RI4KejVeTg6mIS7IqxnLJ8Mv2tV5rTc0qWobay7pDUz6Wi392Cnc8ak1H0F2cjoRzb2/AW4+Fvg==
-tiny-slider@^2.9.3:
- version "2.9.4"
- resolved
"https://registry.yarnpkg.com/tiny-slider/-/tiny-slider-2.9.4.tgz#dd5cbf3065f1688ade8383ea6342aefcba22ccc4";
- integrity
sha512-LAs2kldWcY+BqCKw4kxd4CMx2RhWrHyEePEsymlOIISTlOVkjfK40sSD7ay73eKXBLg/UkluAZpcfCstimHXew==
-
tiny-warning@^1.0.0, tiny-warning@^1.0.3:
version "1.0.3"
resolved
"https://registry.yarnpkg.com/tiny-warning/-/tiny-warning-1.0.3.tgz#94a30db453df4c643d0fd566060d60a875d84754";
