From fc4e5503726783a7f678f31d185f924b05614869 Mon Sep 17 00:00:00 2001 From: VampireAchao Date: Tue, 3 Oct 2023 16:19:21 +0800 Subject: [PATCH] [Improve] Localization Contribution Guide (#263) --- .../contribution_guide/become_committer.md | 59 ++++ .../contribution_guide/become_pmc_member.md | 58 ++++ .../contribution_guide/mailing_lists.md | 60 ++++ .../new_committer_process.md | 245 +++++++++++++++ .../new_pmc_member_process.md | 286 ++++++++++++++++++ 5 files changed, 708 insertions(+) create mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/become_committer.md create mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/become_pmc_member.md create mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/mailing_lists.md create mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/new_committer_process.md create mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/new_pmc_member_process.md diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/become_committer.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/become_committer.md new file mode 100644 index 000000000..7e7f55ff3 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/become_committer.md @@ -0,0 +1,59 @@ +--- +id: 'become_committer' +title: '成为Committer' +sidebar_position: 2 +--- + + + + +## 成为 Apache StreamPark 的 Committer + +任何支持社区并在 CoPDoC 领域中工作的人都可以成为 Apache StreamPark 的Committer。CoPDoC 是 ASF 的缩写，用来描述我们如何不仅仅通过代码来认识到您的贡献。 + +- **Co**mmunity（社区） - 你可以通过我们的邮件列表、问题追踪器、讨论页面与社区成员互动，并分享愿景和知识。 +- **P**roject（项目） - 需要明确的愿景和共识。 +- **Do**cumentation（文档） - 没有它，内容只会停留在作者的头脑中。 +- **C**ode（代码） - 没有代码，讨论就毫无意义。 + +Apache StreamPark 社区努力追求基于功绩的原则。因此，一旦有人在 CoPDoC 的任何领域有了足够的贡献，他们就可以成为 Committer 的候选人，最终被投票选为 StreamPark 的 Committer。成为 Apache StreamPark 的 Committer 并不一定意味着你必须使用你的提交权限向代码库提交代码；它意味着你致力于 StreamPark 项目并为我们社区的成功做出了积极的贡献。 + +## Committer 的要求： + +没有成为 Committer 或 PPMC 成员的严格规则。新的 Committer 的候选人通常是积极的贡献者和社区成员。但是，如果能稍微明确一些规则，就可以在一定程度上消除贡献者的疑虑，使社区更加透明、合理和公平。 + +### 持续的贡献 + +Committer 的候选人应该持续参与并为 StreamPark 做出大量的贡献（例如修复漏洞、添加新功能、编写文档、维护问题板、代码审查或回答社区问题），无论是向主网站的代码库还是 StreamPark 的 GitHub 仓库贡献。 + +- +3 个月的轻度活动和参与。 +- +2 个月的中度活动和参与。 +- +1 个月的高度活动和参与。 + +### 贡献的质量 +- 对项目有深入的理解。 +- 经过充分测试、良好设计、遵循 Apache StreamPark 的编码标准，及简单的修复补丁。 +- 井井有条的面向用户的详细文档。 + +### 社区参与 + +- 在开发邮件列表上保持积极、礼貌与尊重，并帮助指导新的贡献者和用户。 +- 在项目维护的问题跟踪器上积极、有礼貌与尊重。 +- 对于拉取请求审查保持积极、有礼貌与尊重。 +- 即使存在分歧，也要以专业和外交的态度参与技术路线图的讨论。 +- 通过撰写文章或举办活动来推广项目。 \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/become_pmc_member.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/become_pmc_member.md new file mode 100644 index 000000000..a44f3bf69 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/become_pmc_member.md @@ -0,0 +1,58 @@ +--- +id: 'become_pmc_member' +title: '成为PMC member' +sidebar_position: 3 +--- + + + +## 成为 Apache StreamPark 的 PMC 成员 + +任何支持社区并在 CoPDoC 领域中工作的人都可以成为 Apache StreamPark 的PMC 成员。CoPDoC 是 ASF 的缩写，用来描述我们如何不仅仅通过代码来认识到您的贡献。 + +- **Co**mmunity（社区） - 您可以通过我们的邮件列表、问题追踪器、讨论页面与社区成员互动，并分享愿景和知识。 +- **P**roject（项目） - 需要明确的愿景和共识。 +- **Do**cumentation（文档） - 没有它，内容只会停留在作者的头脑中。 +- **C**ode（代码） - 没有代码，讨论就毫无意义。 + +Apache StreamPark 社区努力追求基于功绩的原则。因此，一旦有人在 CoPDoC 的任何领域有了足够的贡献，他们就可以成为 PMC 成员资格的候选人，最终被投票选为 StreamPark 的 PMC 成员。成为 Apache StreamPark 的 PMC 成员并不一定意味着您必须使用您的提交权限向代码库提交代码；它意味着您致力于 StreamPark 项目并为我们社区的成功做出了积极的贡献。 + +## PMC 成员的要求： + +没有成为 Committer 或 PPMC 成员的严格规则。新的 PMC 成员的候选人通常是积极的贡献者和社区成员。但是，如果能稍微明确一些规则，就可以在一定程度上消除贡献者的疑虑，使社区更加透明、合理和公平。 + +### 持续的贡献 + +PMC 成员的候选人应该持续参与并为 StreamPark 做出大量的贡献（例如修复漏洞、添加新功能、编写文档、维护问题板、代码审查或回答社区问题），无论是向主网站的代码库还是 StreamPark 的 GitHub 仓库贡献。 + +- +5 个月的轻度活动和参与。 +- +4 个月的中度活动和参与。 +- +3 个月的高度活动和参与。 + +### 贡献的质量 +- 对项目有深入的理解。 +- 经过充分测试、良好设计、遵循 Apache StreamPark 的编码标准，及简单的修复补丁。 +- 井井有条的面向用户的详细文档。 + +### 社区参与 + +- 在开发邮件列表上保持积极、礼貌与尊重，并帮助指导新的贡献者和用户。 +- 在项目维护的问题跟踪器上积极、有礼貌与尊重。 +- 对于拉取请求审查保持积极、有礼貌与尊重。 +- 即使存在分歧，也要以专业和外交的态度参与技术路线图的讨论。 +- 通过撰写文章或举办活动来推广项目。 \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/mailing_lists.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/mailing_lists.md new file mode 100644 index 000000000..18b6f6503 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/mailing_lists.md @@ -0,0 +1,60 @@ +--- +id: 'mailing_lists' +title: '邮件列表' +sidebar_position: 1 +--- + + + +StreamPark 开发者邮件列表是您在使用 StreamPark 时提出所有问题的首选方式，它能将您的问题推向整个社区。 +这是与社区保持同步的最佳方式。 + +在您向邮件列表发送任何内容之前，请确保您已经**订阅**了它们。 +当前可用的列表在下表中列出。 + +## 用途 + +### 开发者列表 + +- 使用此列表提出您对 StreamPark 的问题 +- 由 StreamPark 贡献者用来讨论 StreamPark 的开发 + +### 提交列表 + +- 关于 StreamPark 代码库的更改的通知 + +| 列表名称 | 地址 | 订阅 | 退订 | 归档 | +|---------------------|------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------|-----------------------------------------------------------------------------| +| **开发者列表** | dev@streampark.apache.org | [订阅](mailto:dev-subscribe@streampark.apache.org) | [退订](mailto:dev-unsubscribe@streampark.apache.org) | [归档](https://lists.apache.org/list.html?dev@streampark.apache.org) | +| **提交列表** | commits@streampark.apache.org | [订阅](mailto:commits-subscribe@streampark.apache.org) | [退订](mailto:commits-unsubscribe@streampark.apache.org) | [归档](https://lists.apache.org/list.html?commits@streampark.apache.org) | + +## 订阅步骤 + +发送订阅邮件也很简单。步骤如下： + +- 1、**订阅**：点击上表中的 **订阅** 按钮，它将重定向到您的邮件客户端。主题和内容是任意的。 + 之后，您会从 dev-help@streampark.apache.org 收到确认邮件（如果没有收到，请确认电子邮件是否被自动分类为垃圾邮件、推广邮件、订阅邮件等）。 +- 2、**确认**：直接回复确认邮件，或点击邮件中的链接快速回复。主题和内容是任意的。 +- 3、**欢迎**：在完成上述步骤后，您会收到一个主题为 WELCOME to dev@streampark.apache.org 的欢迎邮件，您已成功订阅 Apache StreamPark 邮件列表。 + +## 发送纯文本邮件 + +在发送邮件列表时，请使用纯文本邮件。 +**不要使用 HTML 邮件**。 +HTML 邮件更有可能被视为垃圾邮件并被拒绝。 +通过不同的邮件客户端，它可能会出现格式错误，并且其他人不容易阅读。 \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/new_committer_process.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/new_committer_process.md new file mode 100644 index 000000000..0240a5bec --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/new_committer_process.md @@ -0,0 +1,245 @@ +--- +id: 'new_committer_process' +title: '提名新Committer流程' +sidebar_position: 4 +--- + + + +此指南基于 [apache newcommitter](https://community.apache.org/newcommitter.html#new-committer-process) + +## 提名新Committer的流程 + +- 在邮件`private@streampark.apache.org`中发起投票 + + 参见 **Committer投票模板** + +- 关闭投票 + + 参见 **关闭投票模板** + +- 如果结果是赞成，邀请新的Committer + + 参见 **Committer邀请模板** + +- 如果同意，那么：接受Committer + + 参见 **Committer接受模板** + +- 等待我们看到CLA的接收记录 + +- 请求创建Committer账户 + + 参见 **Committer账户创建模板** + + - 等待root告诉我们已经完成 + - PMC主席开启svn和其他访问权限 + - 在JIRA和CWiki中将Committer添加到适当的组中 + +- 通知Committer完成 + + 参见 **Committer完成模板** + +## 模板 + +请注意，模板中有三个占位符在使用之前应该替换： + +- NEW_COMMITTER_NAME +- NEW_COMMITTER_EMAIL +- NEW_COMMITTER_APACHE_NAME + +### Committer投票模板 + +```text +To: private@streampark.apache.org +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} +``` + +注意，投票将在今天一周后结束，即 +[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +参考投票[指南](https://community.apache.org/newcommitter.html) + +### 关闭投票模板 + +```text +To: private@streampark.apache.org +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邀请模板 + +```text +To: ${NEW_COMMITTER_EMAIL} +Cc: private@streampark.apache.org +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 private@streampark.apache.org +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接受模板 + +```text +To: ${NEW_COMMITTER_EMAIL} +Cc: private@streampark.apache.org +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 dev@streampark.apache.org 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 dev@streampark.apache.org list. +We generally discuss everything there and keep the +private@streampark.apache.org 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完成模板 + +```text +To: private@streampark.apache.org, ${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 dev@streampark.apache.org 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. +``` \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/new_pmc_member_process.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/new_pmc_member_process.md new file mode 100644 index 000000000..786cce013 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/new_pmc_member_process.md @@ -0,0 +1,286 @@ +--- +id: 'new_pmc_ember_process' +title: '提名新PMC成员流程' +sidebar_position: 5 +--- + + + +这个指南是基于 [apache newcommitter](https://community.apache.org/newcommitter.html#new-committer-process) 的。 + +## 新PMC成员的流程 + +- 在邮件`private@streampark.apache.org`中进行投票 + + 参见 **PMC成员投票模板** + +- 关闭投票 + + 参见 **关闭投票模板** + +- 董事会批准新的PMC成员 + + 参见 **董事会批准新PMC成员** + +- 如果结果是赞成，邀请新的PMC成员 + + 参见 **PMC成员邀请模板** + +- 如果同意，那么：接受PMC成员 + + 参见 **PMC成员接受模板** + +- 通知PMC成员完成 + + 参见 **PMC成员完成模板** + +- 宣布新的PMC成员 + + 参见 **PMC成员公告模板** + +## 模板 + +注意，在使用模板之前，有三个占位符需要被替换 + +- NEW_PMC_NAME +- NEW_PMC_EMAIL +- NEW_PMC_APACHE_NAME + +### PMC成员投票模板 + +```text +To: private@streampark.apache.org +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} +``` + +注意，投票将在今天一周后结束，即 +[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +参考投票[指南](https://community.apache.org/newcommitter.html) + + +### Close Vote Template + +```text +To: private@streampark.apache.org +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: board@apache.org +Cc: private@.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/... +``` + +参考 [newpmc](https://www.apache.org/dev/pmc.html#newpmc) + +### PMC成员邀请模板 + +```text +To: ${NEW_PMC_EMAIL} +Cc: private@streampark.apache.org +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 private@streampark.apache.org +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成员接受模板 + +```text +To: ${NEW_PMC_EMAIL} +Cc: private@streamparkv.apache.org +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 dev@streampark.apache.org 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 dev@streampark.apache.org list. +We generally discuss everything there and keep the +private@streampark.apache.org 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成员完成模板 + +```text +To: private@streampark.apache.org, ${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 dev@streampark.apache.org 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成员通知模板 + +```text +To: dev@streampark.apache.org +[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 +```