You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2018/03/03 13:20:45 UTC
[incubator-servicecomb-website] branch master updated: SCB-349 add document about how to use JIRA

This is an automated email from the ASF dual-hosted git repository.

ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 1720f73  SCB-349 add document about how to use JIRA
1720f73 is described below

commit 1720f73d4589e22c26cd98687dc26e2a7e98e6a5
Author: lijasonvip <li...@huawei.com>
AuthorDate: Mon Feb 26 15:03:42 2018 +0800

    SCB-349 add document about how to use JIRA
---
 _data/navigation.yml         |   4 ++++
 _developers/cn/use-jira.md   |  41 +++++++++++++++++++++++++++++++++++++++++
 _developers/use-jira.md      |  41 +++++++++++++++++++++++++++++++++++++++++
 assets/images/components.png | Bin 0 -> 23883 bytes
 assets/images/filter.png     | Bin 0 -> 77889 bytes
 assets/images/issue.png      | Bin 0 -> 38823 bytes
 assets/images/kanban.png     | Bin 0 -> 85657 bytes
 assets/images/pr.png         | Bin 0 -> 82705 bytes
 assets/images/progress.png   | Bin 0 -> 63089 bytes
 assets/images/sign-up.png    | Bin 0 -> 33557 bytes
 10 files changed, 86 insertions(+)

diff --git a/_data/navigation.yml b/_data/navigation.yml
index 48e8573..843a0eb 100755
--- a/_data/navigation.yml
+++ b/_data/navigation.yml
@@ -119,6 +119,8 @@ t:
         url: /developers/setup-develop-environment/
       - title: "Code Submit Guide"
         url: /developers/submit-codes/
+      - title: "Howto Use JIRA"
+        url: /developers/use-jira/
       - title: "Set Up Write Access for Committer"
         url: /developers/setup-committer-rights/
 
@@ -251,6 +253,8 @@ t:
         url: /cn/developers/setup-develop-environment/
       - title: "代码提交指南"
         url: /cn/developers/submit-codes/
+      - title: "JIRA使用方法"
+        url: /cn/developers/use-jira/
       - title: "设置代码仓库写权限"
         url: /cn/developers/setup-committer-rights/
     
diff --git a/_developers/cn/use-jira.md b/_developers/cn/use-jira.md
new file mode 100644
index 0000000..f1cc961
--- /dev/null
+++ b/_developers/cn/use-jira.md
@@ -0,0 +1,41 @@
+---
+title: "JIRA使用指南"
+lang: cn 
+ref: use-jira
+permalink: /cn/developers/use-jira/
+excerpt: "介绍 ServiceComb 如何使用JIRA"
+last_modified_at: 2018-02-28T11:26:43-20:46
+---
+
+{% include toc %}
+
+## JIRA使用简介
+　　JIRA是Atlassian公司出品的项目与实务跟踪工具，被广泛应用于缺陷跟踪、客户实务、需求收集、流程审批、任务跟踪、项目跟踪和敏捷管理等工作领域。ServiceComb使用JIRA进行缺陷和任务跟踪，本文将简单介绍在ServiceComb的开发过程中如何使用JIRA。
+
+## 注册并登陆到JIRA
+　　在浏览器中打开[JIRA注册页面](https://issues.apache.org/jira/secure/Signup!default.jspa)，填入个人邮箱，姓名等注册信息后即可注册。注册成功后登录并进入[ServiceComb项目](https://issues.apache.org/jira/projects/SCB/)
+
+## 查看issues
+	登录到JIRA后左侧面板依次是Kanban, Releases, Reports, Issues, Components. Kanban内容如下图，展示了当前需要完成的任务（73 To Do），正在解决中任务（3 In Progress）和已经解决的任务（79 Done），所有任务的编号都以SCB（ServiceComb的简写）开头，可以点击任务栏查看每个任务的详细信息。
+
+![](/assets/images/kanban.png){: .align-center}
+
+	点击左侧面板中Issues可以看到所有的任务并支持自定义过滤规则进行筛选查看，点击右上角View all issues and filters即可进行过滤，默认过滤规则包括任务类型、任务进度、负责人、当前状态等，也可以使用Advanced功能进行高级过滤筛选。
+
+![](/assets/images/filter.png){: .align-center}
+
+## 新建issue
+
+	点击Create可以新建一个issue，创建的时候需要选择issue类型，包括Task, Bug, Feature, Improvement等，选择类型后在Summary中简单描述一下issue内容，需要详细说明的可以在Description中填写更多内容，需要注意的是ServiceComb包含四个子项目，分别是Java Chassis, Saga, Service-Center和website，所以创建issue的时候要选择具体对应的Component来指定issue属于哪个子项目。
+
+![](/assets/images/issue.png){: .align-center}
+
+	创建好issue后可以将issue指定给自己，启动任务Start Progress，待问题解决后Resolve Issue或Close Issue即可，如下图：
+
+![](/assets/images/progress.png){: .align-center}
+
+	通过提交代码解决该issue的时候需要在创建的PR的title上以issue的SCB编号开头，如下图中[SCB-327]
+
+![](/assets/images/pr.png){: .align-center}
+
+	JIRA更多使用方法请参考[官方文档](https://confluence.atlassian.com/jiracoreserver076/getting-started-as-a-user-945112029.html)。
diff --git a/_developers/use-jira.md b/_developers/use-jira.md
new file mode 100644
index 0000000..1e2394f
--- /dev/null
+++ b/_developers/use-jira.md
@@ -0,0 +1,41 @@
+---
+title: "Howto Use JIRA"
+lang: en
+ref: use-jira
+permalink: /developers/use-jira/
+excerpt: "Howto use JIRA"
+last_modified_at: 2018-02-28T11:26:43-20:46
+---
+
+{% include toc %}
+
+## JIRA使用简介
+　　JIRA是Atlassian公司出品的项目与实务跟踪工具，被广泛应用于缺陷跟踪、客户实务、需求收集、流程审批、任务跟踪、项目跟踪和敏捷管理等工作领域。ServiceComb使用JIRA进行缺陷和任务跟踪，本文将简单介绍在ServiceComb的开发过程中如何使用JIRA。
+
+## 注册并登陆到JIRA
+　　在浏览器中打开[JIRA注册页面](https://issues.apache.org/jira/secure/Signup!default.jspa)，填入个人邮箱，姓名等注册信息后即可注册。注册成功后登录并进入[ServiceComb项目](https://issues.apache.org/jira/projects/SCB/)
+
+## 查看issues
+	登录到JIRA后左侧面板依次是Kanban, Releases, Reports, Issues, Components. Kanban内容如下图，展示了当前需要完成的任务（73 To Do），正在解决中任务（3 In Progress）和已经解决的任务（79 Done），所有任务的编号都以SCB（ServiceComb的简写）开头，可以点击任务栏查看每个任务的详细信息。
+
+![](/assets/images/kanban.png){: .align-center}
+
+	点击左侧面板中Issues可以看到所有的任务并支持自定义过滤规则进行筛选查看，点击右上角View all issues and filters即可进行过滤，默认过滤规则包括任务类型、任务进度、负责人、当前状态等，也可以使用Advanced功能进行高级过滤筛选。
+
+![](/assets/images/filter.png){: .align-center}
+
+## 新建issue
+
+	点击Create可以新建一个issue，创建的时候需要选择issue类型，包括Task, Bug, Feature, Improvement等，选择类型后在Summary中简单描述一下issue内容，需要详细说明的可以在Description中填写更多内容，需要注意的是ServiceComb包含四个子项目，分别是Java Chassis, Saga, Service-Center和website，所以创建issue的时候要选择具体对应的Component来指定issue属于哪个子项目。
+
+![](/assets/images/issue.png){: .align-center}
+
+	创建好issue后可以将issue指定给自己，启动任务Start Progress，待问题解决后Resolve Issue或Close Issue即可，如下图：
+
+![](/assets/images/progress.png){: .align-center}
+
+	通过提交代码解决该issue的时候需要在创建的PR的title上以issue的SCB编号开头，如下图中[SCB-327]
+
+![](/assets/images/pr.png){: .align-center}
+
+	JIRA更多使用方法请参考[官方文档](https://confluence.atlassian.com/jiracoreserver076/getting-started-as-a-user-945112029.html)。
diff --git a/assets/images/components.png b/assets/images/components.png
new file mode 100644
index 0000000..f40154d
Binary files /dev/null and b/assets/images/components.png differ
diff --git a/assets/images/filter.png b/assets/images/filter.png
new file mode 100644
index 0000000..6ec2df2
Binary files /dev/null and b/assets/images/filter.png differ
diff --git a/assets/images/issue.png b/assets/images/issue.png
new file mode 100644
index 0000000..72a4152
Binary files /dev/null and b/assets/images/issue.png differ
diff --git a/assets/images/kanban.png b/assets/images/kanban.png
new file mode 100644
index 0000000..4aa3435
Binary files /dev/null and b/assets/images/kanban.png differ
diff --git a/assets/images/pr.png b/assets/images/pr.png
new file mode 100644
index 0000000..236de65
Binary files /dev/null and b/assets/images/pr.png differ
diff --git a/assets/images/progress.png b/assets/images/progress.png
new file mode 100644
index 0000000..ce991c1
Binary files /dev/null and b/assets/images/progress.png differ
diff --git a/assets/images/sign-up.png b/assets/images/sign-up.png
new file mode 100644
index 0000000..977c6b8
Binary files /dev/null and b/assets/images/sign-up.png differ

-- 
To stop receiving notification emails like this one, please contact
ningjiang@apache.org.