You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by go...@apache.org on 2021/07/29 07:04:31 UTC
[incubator-inlong-website] branch master updated:
[INLONG-1394][Platform] Update the document after Migrate InLong Issues
from JIRA to GitHub (#120)
This is an automated email from the ASF dual-hosted git repository.
gosonzhang 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 d09dabb [INLONG-1394][Platform] Update the document after Migrate InLong Issues from JIRA to GitHub (#120)
d09dabb is described below
commit d09dabb1de02d2d112af6618559fcd637bda8f23
Author: dockerzhang <do...@apache.org>
AuthorDate: Thu Jul 29 15:04:27 2021 +0800
[INLONG-1394][Platform] Update the document after Migrate InLong Issues from JIRA to GitHub (#120)
Co-authored-by: dockerzhang <do...@tencent.com>
---
docs/en-us/contact.md | 2 +-
.../en-us/development/how-to-become-a-committer.md | 2 +-
docs/en-us/development/how-to-contribute.md | 14 ++++++-------
docs/en-us/development/how-to-release.md | 2 +-
.../development/how-to-vote-a-committer-ppmc.md | 2 +-
docs/zh-cn/contact.md | 2 +-
.../zh-cn/development/how-to-become-a-committer.md | 2 +-
docs/zh-cn/development/how-to-contribute.md | 24 +++++++++-------------
docs/zh-cn/development/how-to-release.md | 2 +-
.../development/how-to-vote-a-committer-ppmc.md | 2 +-
site_config/development.js | 8 --------
11 files changed, 24 insertions(+), 38 deletions(-)
diff --git a/docs/en-us/contact.md b/docs/en-us/contact.md
index 7278e92..6e9581f 100644
--- a/docs/en-us/contact.md
+++ b/docs/en-us/contact.md
@@ -12,7 +12,7 @@ Contact us
| [dev@inlong.apache.org](mailto:dev@inlong.apache.org) | Development-related discussions | [Subscribe](mailto:dev-subscribe@inlong.apache.org) | [Unsubscribe](mailto:dev-unsubscribe@inlong.apache.org) | [Archives](http://mail-archives.apache.org/mod_mbox/inlong-dev/) |
- Home page: https://inlong.apache.org
-- Issues: https://issues.apache.org/jira/browse/InLong
+- GitHub Issues: https://github.com/apache/incubator-inlong/issues
diff --git a/docs/en-us/development/how-to-become-a-committer.md b/docs/en-us/development/how-to-become-a-committer.md
index d31d671..7577686 100644
--- a/docs/en-us/development/how-to-become-a-committer.md
+++ b/docs/en-us/development/how-to-become-a-committer.md
@@ -21,7 +21,7 @@ Apache InLong Committer拥有InLong代码库的写权限，可以合并PR，任
- 参与邮件列表中的讨论，一般会有以[DISCUSS]开头的邮件
- 回答用户或开发人员在邮件列表中的提问
- 审查(Review)其他人的工作（包括代码和非代码）并发表你自己的建议
-- 对JIRA上的issue进行审查，维护issue为最新状态，比如：关闭过时的issue、更改issue的错误信息等
+- 对GitHub上的issue进行审查，维护issue为最新状态，比如：关闭过时的issue、更改issue的错误信息等
- 指导新加入的贡献者，熟悉社区流程
- 发表关于InLong的演讲和博客，并将这些添加到InLong的官方网站
- 有利于InLong社区发展的任何贡献
diff --git a/docs/en-us/development/how-to-contribute.md b/docs/en-us/development/how-to-contribute.md
index e798bc1..f112896 100644
--- a/docs/en-us/development/how-to-contribute.md
+++ b/docs/en-us/development/how-to-contribute.md
@@ -10,7 +10,7 @@ We use a review-then-commit workflow in InLong for all contributions.
**For larger contributions or those that affect multiple components:**
-1. **Engage**: We encourage you to work with the InLong community on the [JIRA](https://jira.apache.org/jira/browse/INLONG) and [developer’s mailing list](../contact.html) to identify good areas for contribution.
+1. **Engage**: We encourage you to work with the InLong community on the [GitHub](https://github.com/apache/incubator-inlong/issues) and [developer’s mailing list](../contact.html) to identify good areas for contribution.
2. **Design:** More complicated contributions will likely benefit from some early discussion in order to scope and design them well.
**For all contributions:**
@@ -27,18 +27,16 @@ We look forward to working with you!
We discuss design and implementation issues on the [dev@inlong.apache.org](mailto:dev@inlong.apache.org) mailing list, which is archived [here](https://lists.apache.org/list.html?dev@inlong.apache.org). Join by emailing [`dev-subscribe@inlong.apache.org`](mailto:dev-subscribe@inlong.apache.org).
-### JIRA
+### GitHub Issue
-We are using [JIRA](https://jira.apache.org/jira/browse/INLONG) as the issue tracking
+We are using [GitHub](https://github.com/apache/incubator-inlong/issues) as the issue tracking
and project management tool, as well as a way to communicate among a very diverse and distributed set of contributors. To be able to gather feedback, avoid frustration, and avoid duplicated efforts all InLong related work are being tracked there.
-If you do not already have an JIRA account, sign up [here](https://jira.apache.org/jira/secure/Signup!default.jspa).
+If a quick [search](https://github.com/apache/incubator-inlong/issues) doesn’t turn up an existing GitHub issue for the work you want to contribute, create it. Please discuss your idea with a committer in GitHub or, alternatively, on the developer mailing list.
-If a quick [search](https://jira.apache.org/jira/projects/INLONG/issues) doesn’t turn up an existing JIRA issue for the work you want to contribute, create it. Please discuss your idea with a committer in JIRA or, alternatively, on the developer mailing list.
+If there’s an existing GitHub issue for your intended contribution, please comment about your intended work. Once the work is understood, a committer will assign the issue to you. If an issue is currently assigned, please check with the current assignee before reassigning.
-If there’s an existing JIRA issue for your intended contribution, please comment about your intended work. Once the work is understood, a committer will assign the issue to you. If an issue is currently assigned, please check with the current assignee before reassigning.
-
-For moderate or large contributions, you should not start coding or writing a design document unless there is a corresponding JIRA issue assigned to you for that work. Any change requires an associated JIRA issue.
+For moderate or large contributions, you should not start coding or writing a design document unless there is a corresponding GitHub issue assigned to you for that work. Any change requires an associated GitHub issue.
## Design
diff --git a/docs/en-us/development/how-to-release.md b/docs/en-us/development/how-to-release.md
index 56fde49..64e5227 100644
--- a/docs/en-us/development/how-to-release.md
+++ b/docs/en-us/development/how-to-release.md
@@ -511,7 +511,7 @@ Release Notes: https://inlong.apache.org/en-us/docs/download/${release_version}.
Website: https://inlong.apache.org/
InLong Resources:
-- Issue: https://issues.apache.org/jira/projects/INLONG/issues
+- Issue: https://github.com/apache/incubator-inlong/issues
- Mailing list: dev@inlong.apache.org
Thanks
diff --git a/docs/en-us/development/how-to-vote-a-committer-ppmc.md b/docs/en-us/development/how-to-vote-a-committer-ppmc.md
index 4047269..ea5bb07 100644
--- a/docs/en-us/development/how-to-vote-a-committer-ppmc.md
+++ b/docs/en-us/development/how-to-vote-a-committer-ppmc.md
@@ -38,7 +38,7 @@ title: How to vote a Committer or PPMC - Apache InLong
7. 如果以上内容都以完成，投票发起者还需要做如下2件事情：
- 7.1 向项目负责人申请添加项目组成员，开通jira及apache项目的权限帐号。
+ 7.1 向项目负责人申请添加项目组成员，开通apache项目的权限帐号。
7.2 向dev@inlong.apache.org邮件组发通知邮件：
> [ANNOUNCE] New XXXXXX: YYYYY
diff --git a/docs/zh-cn/contact.md b/docs/zh-cn/contact.md
index 5c32170..228bc1c 100644
--- a/docs/zh-cn/contact.md
+++ b/docs/zh-cn/contact.md
@@ -13,7 +13,7 @@ title: 联系我们 - Apache InLong
| [dev@inlong.apache.org](mailto:dev@inlong.apache.org) | Development-related discussions | [Subscribe](mailto:dev-subscribe@inlong.apache.org) | [Unsubscribe](mailto:dev-unsubscribe@inlong.apache.org) | [Archives](http://mail-archives.apache.org/mod_mbox/inlong-dev/) |
- 项目主页: https://inlong.apache.org
-- 需求与问题: https://issues.apache.org/jira/browse/InLong
+- 需求与问题: https://github.com/apache/incubator-inlong/issues
diff --git a/docs/zh-cn/development/how-to-become-a-committer.md b/docs/zh-cn/development/how-to-become-a-committer.md
index ba7b9e9..f27f3d1 100644
--- a/docs/zh-cn/development/how-to-become-a-committer.md
+++ b/docs/zh-cn/development/how-to-become-a-committer.md
@@ -19,7 +19,7 @@ Apache InLong Committer拥有InLong代码库的写权限，可以合并PR，任
- 参与邮件列表中的讨论，一般会有以[DISCUSS]开头的邮件
- 回答用户或开发人员在邮件列表中的提问
- 审查(Review)其他人的工作（包括代码和非代码）并发表你自己的建议
-- 对JIRA上的issue进行审查，维护issue为最新状态，比如：关闭过时的issue、更改issue的错误信息等
+- 对GitHub上的issue进行审查，维护issue为最新状态，比如：关闭过时的issue、更改issue的错误信息等
- 指导新加入的贡献者，熟悉社区流程
- 发表关于InLong的演讲和博客，并将这些添加到InLong的官方网站
- 有利于InLong社区发展的任何贡献
diff --git a/docs/zh-cn/development/how-to-contribute.md b/docs/zh-cn/development/how-to-contribute.md
index 819f55a..197b63f 100644
--- a/docs/zh-cn/development/how-to-contribute.md
+++ b/docs/zh-cn/development/how-to-contribute.md
@@ -6,10 +6,10 @@ title: 如何参与贡献 - Apache InLong
Apache InLong社区欢迎大家为Apache InLong做贡献，您可以通过很多方式为InLong项目成长贡献一份力量：
- 贡献文档：浏览文档可以加深您对InLong的了解，一旦发现文档写得不清晰或逻辑混乱的地方，可以订正、修改、补充或[联系我们](mailto:dev@inlong.apache.org)
- 贡献代码：欢迎大家为InLong社区贡献代码
- - 欢迎您认领Open状态的[Issues](https://issues.apache.org/jira/projects/INLONG/issues)和未完成的特性，提交PR，成为贡献者之一
+ - 欢迎您认领Open状态的[Issues](https://github.com/apache/incubator-inlong/issues)和未完成的特性，提交PR，成为贡献者之一
- 如果您在使用过程中发现有些功能无法满足您的需求或出现问题，请在Issues中记录
- 参与邮件讨论：您可以参与dev邮件列表的任何讨论，或者发送任何疑问到dev邮件列表
- - 参与Issue讨论：您可以在任一[Issues](https://issues.apache.org/jira/projects/INLONG/issues)下发表您的建议
+ - 参与Issue讨论：您可以在任一[Issues](https://github.com/apache/incubator-inlong/issues)下发表您的建议
- Review代码：您可以在[GitHub](https://github.com/apache/incubator-inlong/pulls)上看到所有贡献者提交的PR，您可以Review他们的代码并发表您的建议
> 欢迎大家提交Bug反馈、改进、新功能及PR，具体参与贡献流程可参考该指引。
@@ -17,22 +17,18 @@ Apache InLong社区欢迎大家为Apache InLong做贡献，您可以通过很多
- 官网：https://inlong.apache.org/
- 代码库：https://github.com/apache/incubator-inlong
- 官网代码库：https://github.com/apache/incubator-inlong-website
-- JRIA任务管理：https://issues.apache.org/jira/projects/INLONG/issues
+- GitHub Issue任务管理：https://github.com/apache/incubator-inlong/issues
## 2. 订阅InLong邮件列表
详见[如何订阅邮件列表](how-to-subscribe.md)
-## 3. 注册Jira账号
+## 3. 提交Bug反馈/特性/改进/文档
-Apache InLong使用Apache官方提供的任务管理平台对InLong相关的任务进行管理，JIRA的使用详见[JIRA使用指南](how-to-use-jira.md)
+> Apache InLong使用GitHub对InLong相关的任务进行管理，详见：https://github.com/apache/incubator-inlong/issues
-## 4. 提交Bug反馈/特性/改进/文档
-
-> Apache InLong使用Apache官方提供的任务管理平台对InLong相关的任务进行管理，详见：https://issues.apache.org/jira/projects/INLONG/issues
-
-### 4.1 创建issue
-详见[JIRA使用指南](how-to-use-jira.md)
-### 4.2 如何提交Bug/特性/改进
+### 3.1 创建issue
+详见[GitHub Issue使用指南](https://github.com/apache/incubator-inlong/issues/new/choose)
+### 3.2 如何提交Bug/特性/改进
在您提交特性/改进前，应该注意以下几点：
- 请先确认该特性/改进是否被其他人已经提交
- 一个通俗易懂的标题来阐述你提交的Bug/提交特性/改进
@@ -46,7 +42,7 @@ Apache InLong使用Apache官方提供的任务管理平台对InLong相关的任
- 如果是比较大的特性/改进，尽量先输出设计文档，供其他人review
- 编码，编码完成后，提交代码，参考：[代码提交指南](how-to-commit.md)
-### 4.3 如何贡献文档
+### 3.3 如何贡献文档
InLong项目的所有文档将在[官网](https://inlong.apache.org/)展示，所有的文档都保存在官网代码库的[docs](https://github.com/apache/incubator-inlong-website/tree/master/docs)文件夹下。
贡献的文档包括：
- 编写与InLong相关的文档
@@ -58,7 +54,7 @@ InLong项目的所有文档将在[官网](https://inlong.apache.org/)展示，
- 创建issue，描述清楚问题, Component请选择：website
- 撰写文档，完成后提交文档，参考：[代码提交指南](how-to-commit.md)
-### 5. 如何认领Bug/特性/改进/文档
+### 4. 如何认领Bug/特性/改进/文档
在InLong的issue列表中，有很多由其他人创建的issue并未被修复，如果你感兴趣的话，可以认领这些issue。认领步骤如下：
- 在该issue下留言，表达想认领该任务的想法
diff --git a/docs/zh-cn/development/how-to-release.md b/docs/zh-cn/development/how-to-release.md
index 9e7720c..669e35d 100644
--- a/docs/zh-cn/development/how-to-release.md
+++ b/docs/zh-cn/development/how-to-release.md
@@ -509,7 +509,7 @@ Release Notes: https://inlong.apache.org/en-us/docs/download/${release_version}.
Website: https://inlong.apache.org/
InLong Resources:
-- Issue: https://issues.apache.org/jira/projects/INLONG/issues
+- Issue: https://github.com/apache/incubator-inlong/issues
- Mailing list: dev@inlong.apache.org
Thanks
diff --git a/docs/zh-cn/development/how-to-vote-a-committer-ppmc.md b/docs/zh-cn/development/how-to-vote-a-committer-ppmc.md
index 6c10efe..1a70f54 100644
--- a/docs/zh-cn/development/how-to-vote-a-committer-ppmc.md
+++ b/docs/zh-cn/development/how-to-vote-a-committer-ppmc.md
@@ -37,7 +37,7 @@ title: 成为InLong Committer 或 PPMC 的投票过程 - Apache InLong
7. 如果以上内容都以完成，投票发起者还需要做如下2件事情：
- 7.1 向项目负责人申请添加项目组成员，开通jira及apache项目的权限帐号。
+ 7.1 向项目负责人申请添加项目组成员，开通apache项目的权限帐号。
7.2 向dev@inlong.apache.org邮件组发通知邮件：
> [ANNOUNCE] New XXXXXX: YYYYY
diff --git a/site_config/development.js b/site_config/development.js
index 9bf9cab..c03e8a9 100644
--- a/site_config/development.js
+++ b/site_config/development.js
@@ -17,10 +17,6 @@ export default {
link: '/en-us/docs/development/how-to-subscribe.html',
},
{
- title: 'How to use jira',
- link: '/en-us/docs/development/how-to-use-jira.html',
- },
- {
title: 'How to become a committer',
link: '/en-us/docs/development/how-to-become-a-committer.html',
},
@@ -63,10 +59,6 @@ export default {
link: '/zh-cn/docs/development/how-to-subscribe.html',
},
{
- title: '如何使用JIRA',
- link: '/zh-cn/docs/development/how-to-use-jira.html',
- },
- {
title: '如何成为Committer',
link: '/zh-cn/docs/development/how-to-become-a-committer.html',
},