You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2021/11/22 09:04:25 UTC
[incubator-inlong-website] branch master updated: [INLONG-1824] Refine the how-to-vote-a-committer-ppmc.md (#194)
This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 24ac5e9 [INLONG-1824] Refine the how-to-vote-a-committer-ppmc.md (#194)
24ac5e9 is described below
commit 24ac5e99a1d1556f8d4dca7976f14d6925371105
Author: gosonzhang <46...@qq.com>
AuthorDate: Mon Nov 22 17:04:19 2021 +0800
[INLONG-1824] Refine the how-to-vote-a-committer-ppmc.md (#194)
---
development/how-to-vote-a-committer-ppmc.md | 128 +++++++++++++++++----
docs/modules/tubemq/http_access_api.md | 2 +-
.../current/how-to-vote-a-committer-ppmc.md | 123 ++++++++++++++++----
.../current/modules/tubemq/http_access_api.md | 2 +-
4 files changed, 206 insertions(+), 49 deletions(-)
diff --git a/development/how-to-vote-a-committer-ppmc.md b/development/how-to-vote-a-committer-ppmc.md
index 1765bf2..2bc496a 100644
--- a/development/how-to-vote-a-committer-ppmc.md
+++ b/development/how-to-vote-a-committer-ppmc.md
@@ -4,46 +4,124 @@ sidebar_position: 5
---
-# 成为InLong Committer 或 PPMC 的投票过程
-<font color="#dd0000" size="4">TODO: This page needs to be translated into English. If you are interested, just do it.</font>
+# The voting process of becoming an InLong Committer or PPMC
+
+1. Initiate discussion in the community private mailing group：
+ Any InLong PPMC member can initiate a voting discussion. After PPMC finds any valuable contributions from community contributors and obtains the consent of the candidate, they can initiate a discussion on InLong's private mailing list. In the discussion email, the proposer should clearly state the candidate's contribution and give the address for reviewing the corresponding contribution, so that everyone can discuss and analyze it. The discussion email is sent to private@inlong.apache [...]
+ ```shell
+ [DISCUSS] YYYYY as an InLong XXXXXX
+
+ I nominate YYYYY as an InLong XXXXXX
+
+ Judging from the contributions in recent months, YYYYY has submitted many implementations[1],[2] to the project and improved the management module for the project. During the optimization and improvement period of the project, it is hoped that more people will participate in the actual project optimization and improvement, to let the project more perfect and easier to use.
+
+ So I nominated YYYYY as XXXXXX of the InLong project.
+
+ 1. https://github.com/apache/incubator-inlong/issues/created_by/YYYYY
+ 2. https://github.com/apache/incubator-inlong/commits?author=YYYYY
+ ```
+
+2. Initiate vote in the community private mailing group：
+ If the discussion email does not receive the disagreement information within the specified time, the poll initiator needs to initiate a Committer or PPMC election vote on InLong's private mailing list. The voting email is sent to private@inlong.apache.org for at least 72 hours, and at least 3 votes +1 passed; if 0 votes or 1 vote -1 vote, the vote will fail; if a -1 vote is initiated, the voter needs to EXPLAIN the reason for the -1 score clearly so that everyone can understand and kn [...]
+ ```shell
+ [VOTE] YYYYY as an InLong XXXXXX
+
+ Judging from the contributions in recent months, YYYYY has submitted many implementations[1],[2],[3] to the project and improved the management module for the project. During the optimization and improvement period of the project, it is hoped that more people will participate in the actual project optimization and improvement, to let the project more perfect and easier to use.
+ I think making him a XXXXXX will be a recognition of his outstanding work for InLong. So, I am happy to call VOTE to accept YYYYY as an InLong XXXXXX.
+
+ Voting will continue for at least 72 hours or until the required number of votes is reached.
+
+ Please vote accordingly:
+ [ ] +1 approve
+ [ ] +0 no opinion
+ [ ] -1 disapprove with the reason
+
+ Here are three links to his contributions to InLong:
+ 1. Issues: https://github.com/apache/incubator-inlong/pulls?q=YYYYY
+ 2. PRs : https://github.com/apache/incubator-inlong/issues?q=YYYYY
+ 3. Others: https://xxx.com/xxx/xxx/?q=YYYYY
+ ```
+
+3. Feedback on voting results: After the voting email is over, the initiator of the vote needs to remind the voting end in the second [VOTE] email; at the same time, the initiator of the vote needs to initiate a vote summary email, and the summary email is sent to private@inlong.apache.org. The following is a sample vote summary email:
+ ```shell
+ [RESULTS][VOTE] YYYYY as an InLong XXXXXX
+
+ Hi everyone,
-1. InLong的PPMC成员发现社区贡献者任何有价值的贡献并取得候选人本人同意后，在InLong的private邮件列表发起讨论；
- > [DISCUSS] YYYYY as a InLong XXXXXX
+ The vote for "YYYYY as an InLong XXXXXX" has PASSED and closed now.
- 邮件里要把对方的贡献，可以查看的出处说清楚，便于大家讨论分析；讨论邮件将持续至少72个小时，项目组成员，包括mentor们会针对提议邮件充分发表自己的看法；
+ The result is as follows:
-
-2. 不管有没有分歧，在讨论邮件过后，投票发起者需要在在InLong的private邮件列表发起Committer或PPMC的选举投票；
- > [VOTE] YYYYY as a InLong XXXXXX
+ 3 PPMC +1 Votes
+ - aaa
+ - bbb
+ - ccc
- 投票邮件至少持续72小时，至少要3票+1通过，如果0票或者有1票-1票则投票失败；如果-1，需要把问题说清楚，便于大家理解和知晓
+ Vote thread:
+ https://lists.apache.org/thread/aaaaaxxxx
+ Then I'm going to invite YYYYY to join us.
-3. 投票邮件结束后，由投票发起者在投票线上总结并提醒投票结束，并发投票总结邮件；
- > [RESULTS][VOTE] YYYYY as a InLong XXXXXX
+ Thanks for everyone's support!
+ ```
+ Note: If it is not passed, the result is "The vote for "YYYYY as an InLong XXXXXX" has FAILED and closed now."
+4. Newly added PPMC notification email: This step is only processed for the PPMC that passed the vote. If the election is Committer, this step is skipped and not executed. Voting initiators need to send notification emails to IPMC’s private mailing group and wait at least 72 hours; email owners send private@incubator.apache.org and CC private@inlong.apache.org; IPMC will analyze compliance Until there is no doubt. The following is an example of a new PPMC notification email:
+ ```shell
+ [NOTICE] YYYYY for InLong PPMC
+
+ Hi everyone,
-4. 投票总结邮件发出后，投票发起者要给候选人发起邀请邮件，该邀请邮件需要候选人通过指定的邮箱回复接受或者拒绝；
- > [Invitation] Invitation to join Apache InLong as a XXXXXX
+ YYYYY has been voted as a new member of the InLong PPMC.
- 邮件主送邀请人，抄送private@inlong.apache.org
+ The vote thread is at:
+ https://lists.apache.org/thread/aaaaaxxxx
+
+ Thanks!
+ ```
+5. Initiate invitation email: After the result summary email is sent, the poll initiator must send an invitation email to the candidates. The invitation email is sent to the invitee with a CC to private@inlong.apache.org; the invited candidate must reply to accept or decline the invitation through the specified email address. The following is an example of an email inviting candidates:
+ ```shell
+ [Invitation] Invitation to join Apache InLong as a XXXXXX
+
+ Hi YYYYY,
-5. 候选人接受邀请后，如果候选人没有apache邮箱帐号，投票发起者需要协助候选人按照指引创建apache帐号；
+ In recognition of your contributions to Apache InLong, the InLong PPMC
+ has recently voted to add you as a XXXXXX. The XXXXXX role gives
+ you access to merge patches into Apache InLong and is also a
+ stepping-stone towards membership in the
+ Podling Project Management Committee (PPMC). We hope that you accept
+ this invitation and continue to help us make Apache InLong better.
-
-6. 如果选举的是PPMC，在候选人的Apache帐号创建完成后，投票发起者还需要向IPMC的private邮件组发送知会邮件，并等待至少72小时;
- > [NOTICE] XXXXXX for InLong PPMC
+ If you'd like to accept, you will need to send an Individual
+ Contributor License Agreement (ICLA) to secretary@apache.org, CCing
+ private@inlong.apache.org, and request an Apache account name as
+ described at http://www.apache.org/dev/new-committers-guide.html if
+ you don’t already have one, once you get an account name, or if you
+ have one already, please email it to me.
- 邮件主送private@incubator.apache.org，抄送private@inlong.apache.org，IPMC们会分析合规性，直到没有疑义。
+ With the expectation of your acceptance, welcome!
-
-7. 如果以上内容都以完成，投票发起者还需要做如下2件事情：
- 7.1 向项目负责人申请添加项目组成员，开通jira及apache项目的权限帐号。
+ The Apache InLong PPMC
+ ```
- 7.2 向dev@inlong.apache.org邮件组发通知邮件：
- > [ANNOUNCE] New XXXXXX: YYYYY
+6. Processing after accepting the invitation: Create an Apache account and add the candidate account to the project. After the candidate accepts the invitation, if the candidate does not have an apache email account, the voting initiator needs to assist the candidate to create an apache account according to the guidelines. When signing the ICLA, the candidate needs to write the project name of “Apache InLong” in the "notify project:" column, so that the candidate account will be added to [...]
+7. ANNOUNCE to the community: After the above steps are completed, the vote initiator must send a notification email to the dev@inlong.apache.org mail group. The following is a sample notification email:
+ ```shell
+ [ANNOUNCE] New XXXXXX: YYYYY
+
+ Hi everyone,
+
+ The Project Management Committee(PMC) for Apache InLong has invited YYYYY to become a XXXXXX and we are pleased to announce that he has accepted.
-到此，整个流程才算走完，候选人才正式的成为项目的Committer或者PPMC。
+ YYYYY is being active in the InLong community, and we are glad to see his more interactions with the community in the future.
+
+ Welcome YYYYY, and please enjoy your journey.:)
+
+ Thanks!
+
+ ```
+
+At this point, the entire process is completed, and the candidate officially becomes the Committer or PPMC of the project.
diff --git a/docs/modules/tubemq/http_access_api.md b/docs/modules/tubemq/http_access_api.md
index 5ba60bd..f5308e4 100644
--- a/docs/modules/tubemq/http_access_api.md
+++ b/docs/modules/tubemq/http_access_api.md
@@ -913,7 +913,7 @@ __Request__
|needRefresh|no|whether it needs to refresh, default false|Boolean|
More API see:
-<a href="appendixfiles/http_access_api_definition_cn.xls" target="_blank" download="w3logo">TubeMQ HTTP API</a>
+<a href="/appendixfiles/http_access_api_definition_cn.xls" download="http_access_api_definition_cn.xls">TubeMQ HTTP API</a>
---
<a href="#top">Back to top</a>
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-development/current/how-to-vote-a-committer-ppmc.md b/i18n/zh-CN/docusaurus-plugin-content-docs-development/current/how-to-vote-a-committer-ppmc.md
index c86ae47..4d31a8c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs-development/current/how-to-vote-a-committer-ppmc.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-development/current/how-to-vote-a-committer-ppmc.md
@@ -6,43 +6,122 @@ sidebar_position: 5
# 成为InLong Committer 或 PPMC 的投票过程
-1. TubeMQ的PPMC成员发现社区贡献者任何有价值的贡献并取得候选人本人同意后，在InLong的private邮件列表发起讨论；
- > [DISCUSS] YYYYY as a InLong XXXXXX
-
- 邮件里要把对方的贡献，可以查看的出处说清楚，便于大家讨论分析；讨论邮件将持续至少72个小时，项目组成员，包括mentor们会针对提议邮件充分发表自己的看法；
-
+1. 发起社区Private邮件组投票讨论：
+ 任何InLong的PPMC成员都可以发起投票讨论，在PPMC发现社区贡献者任何有价值的贡献并取得候选人本人同意后，可以在InLong的private邮件列表发起讨论。讨论邮件里提议者要把候选人的贡献说清楚，并且给出复核对应贡献的地址，便于大家讨论分析。讨论邮件主送private@inlong.apache.org邮箱，讨论将持续至少72个小时，项目组成员，包括mentor们会针对提议邮件充分发表自己的看法。如下是讨论邮件样例：
+ ```shell
+ [DISCUSS] YYYYY as an InLong XXXXXX
+
+ I nominate YYYYY as an InLong XXXXXX
+
+ Judging from the contributions in recent months, YYYYY has submitted many implementations[1],[2] to the project and improved the management module for the project. During the optimization and improvement period of the project, it is hoped that more people will participate in the actual project optimization and improvement, to let the project more perfect and easier to use.
+
+ So I nominated YYYYY as XXXXXX of the InLong project.
+
+ 1. https://github.com/apache/incubator-inlong/issues/created_by/YYYYY
+ 2. https://github.com/apache/incubator-inlong/commits?author=YYYYY
+ ```
+
+2. 发起社区Private邮件组投票：
+ 如果讨论邮件在规定时间内没有收到分歧信息，投票发起者需要在InLong的private邮件列表发起Committer或PPMC的选举投票。投票邮件主送private@inlong.apache.org，至少持续72小时，至少要3票+1通过；如果0票或者有1票-1投票票则整个投票失败；如果发起-1投票，投票人需要把打分-1的原因说清楚，便于大家理解和知晓。如下是投票邮件样例：
+ ```shell
+ [VOTE] YYYYY as an InLong XXXXXX
+
+ Judging from the contributions in recent months, YYYYY has submitted many implementations[1],[2],[3] to the project and improved the management module for the project. During the optimization and improvement period of the project, it is hoped that more people will participate in the actual project optimization and improvement, to let the project more perfect and easier to use.
+ I think making him a XXXXXX will be a recognition of his outstanding work for InLong. So, I am happy to call VOTE to accept YYYYY as an InLong XXXXXX.
+
+ Voting will continue for at least 72 hours or until the required number of votes is reached.
-2. 不管有没有分歧，在讨论邮件过后，投票发起者需要在在InLong的private邮件列表发起Committer或PPMC的选举投票；
- > [VOTE] YYYYY as a InLong XXXXXX
+ Please vote accordingly:
+ [ ] +1 approve
+ [ ] +0 no opinion
+ [ ] -1 disapprove with the reason
+
+ Here are three links to his contributions to InLong:
+ 1. Issues: https://github.com/apache/incubator-inlong/pulls?q=YYYYY
+ 2. PRs : https://github.com/apache/incubator-inlong/issues?q=YYYYY
+ 3. Others: https://xxx.com/xxx/xxx/?q=YYYYY
+ ```
+
+3. 投票结果反馈：投票邮件结束后，投票发起者需要在第二封[VOTE]邮件里提醒投票结束；同时，投票发起者需要发起邮票总结邮件，总结邮件主送private@inlong.apache.org。如下是投票总结邮件样例：
+ ```shell
+ [RESULTS][VOTE] YYYYY as an InLong XXXXXX
+
+ Hi everyone,
+
+ The vote for "YYYYY as an InLong XXXXXX" has PASSED and closed now.
- 投票邮件至少持续72小时，至少要3票+1通过，如果0票或者有1票-1票则投票失败；如果-1，需要把问题说清楚，便于大家理解和知晓
+ The result is as follows:
+ 3 PPMC +1 Votes
+ - aaa
+ - bbb
+ - ccc
-3. 投票邮件结束后，由投票发起者在投票线上总结并提醒投票结束，并发投票总结邮件；
- > [RESULTS][VOTE] YYYYY as a InLong XXXXXX
+ Vote thread:
+ https://lists.apache.org/thread/aaaaaxxxx
+ Then I'm going to invite YYYYY to join us.
-4. 投票总结邮件发出后，投票发起者要给候选人发起邀请邮件，该邀请邮件需要候选人通过指定的邮箱回复接受或者拒绝；
- > [Invitation] Invitation to join Apache InLong as a XXXXXX
+ Thanks for everyone's support!
+ ```
+ 备注：如果是未通过，结果是 "The vote for "YYYYY as an InLong XXXXXX" has FAILED and closed now."
- 邮件主送邀请人，抄送private@inlong.apache.org
+4. 新增PPMC通知邮件：该步骤只针对投票通过的PPMC进行处理，如果选举的是Committer，该步跳过不执行。投票发起者需要向IPMC的private邮件组发送知会邮件，并等待至少72小时；邮件主送private@incubator.apache.org，抄送private@inlong.apache.org；IPMC们会分析合规性，直到没有疑义。如下是新增PPMC通知邮件样例：
+ ```shell
+ [NOTICE] YYYYY for InLong PPMC
+
+ Hi everyone,
+ YYYYY has been voted as a new member of the InLong PPMC.
-5. 候选人接受邀请后，如果候选人没有apache邮箱帐号，投票发起者需要协助候选人按照指引创建apache帐号；
+ The vote thread is at:
+ https://lists.apache.org/thread/aaaaaxxxx
+
+ Thanks!
+ ```
+5. 发起邀请邮件：投票总结邮件发出后，投票发起人要给候选人发送邀请邮件。邀请邮件主送被邀请人，抄送private@inlong.apache.org；被邀请的候选人必须通过指定的邮箱地址回复接受或者拒绝该邀请。如下是邀请候选人邮件样例：
+ ```shell
+ [Invitation] Invitation to join Apache InLong as a XXXXXX
-6. 如果选举的是PPMC，在候选人的Apache帐号创建完成后，投票发起者还需要向IPMC的private邮件组发送知会邮件，并等待至少72小时;
- > [NOTICE] XXXXXX for InLong PPMC
+ Hi YYYYY,
- 邮件主送private@incubator.apache.org，抄送private@inlong.apache.org，IPMC们会分析合规性，直到没有疑义。
+ In recognition of your contributions to Apache InLong, the InLong PPMC
+ has recently voted to add you as a XXXXXX. The XXXXXX role gives
+ you access to merge patches into Apache InLong and is also a
+ stepping-stone towards membership in the
+ Podling Project Management Committee (PPMC). We hope that you accept
+ this invitation and continue to help us make Apache InLong better.
-
-7. 如果以上内容都以完成，投票发起者还需要做如下2件事情：
- 7.1 向项目负责人申请添加项目组成员，开通apache项目的权限帐号。
+ If you'd like to accept, you will need to send an Individual
+ Contributor License Agreement (ICLA) to secretary@apache.org, CCing
+ private@inlong.apache.org, and request an Apache account name as
+ described at http://www.apache.org/dev/new-committers-guide.html if
+ you don’t already have one, once you get an account name, or if you
+ have one already, please email it to me.
+
+ With the expectation of your acceptance, welcome!
+
+ The Apache InLong PPMC
+ ```
+
+6. 接受邀请后处理：创建Apache帐号并将候选人帐号加入项目。候选人接受邀请后，如果候选人没有apache邮箱帐号，投票发起人需要协助候选人按照指引创建好apache帐号。在签署ICLA时，候选人需要在“notify project:”栏目写上Apache InLong项目名，这样候选人帐号才会被Apache加入对应项目人员名单，如果候选人没有加入项目，投票发起人需要向Mentors申请添加项目组成员，开通apache项目的权限帐号，确认候选人的Apache帐号已加入项目的地址：http://people.apache.org/phonebook.html?podling=inlong。
- 7.2 向dev@inlong.apache.org邮件组发通知邮件：
- > [ANNOUNCE] New XXXXXX: YYYYY
+7. 向社区发布申明邮件：如上步骤都完成后，投票发起人向dev@inlong.apache.org邮件组发通知邮件。如下是通知邮件样例：
+ ```shell
+ [ANNOUNCE] New XXXXXX: YYYYY
+
+ Hi everyone,
+
+ The Project Management Committee(PMC) for Apache InLong has invited YYYYY to become a XXXXXX and we are pleased to announce that he has accepted.
+
+ YYYYY is being active in the InLong community, and we are glad to see his more interactions with the community in the future.
+
+ Welcome YYYYY, and please enjoy your journey.:)
+ Thanks!
+
+ ```
到此，整个流程才算走完，候选人才正式的成为项目的Committer或者PPMC。
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/http_access_api.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/http_access_api.md
index 31d469d..8568748 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/http_access_api.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/http_access_api.md
@@ -14,7 +14,7 @@ HTTP API是Master或者Broker对外功能暴露的接口，管控台的各项操
由于接口众多且参数繁杂，md格式不能比较好的表达，因而以excel附件形式提供给到大家：
-<a href="appendixfiles/http_access_api_definition_cn.xls" target="_blank" download="w3logo">TubeMQ HTTP API</a>
+<a href="/appendixfiles/http_access_api_definition_cn.xls" download="http_access_api_definition_cn.xls">TubeMQ HTTP API</a>
---
<a href="#top">Back to top</a>
\ No newline at end of file