summaryrefslogtreecommitdiff
path: root/doc/project_services
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-01-25 22:17:41 +0100
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-01-25 22:17:41 +0100
commitc53aad315f89e0eaa44ab680d0b79f38c4590083 (patch)
tree22198520661f9fdecb2ffe46dd7e6447f1e407c6 /doc/project_services
parent6c46b79d9a959a9dc74748f6cb3d30fa5ff89264 (diff)
downloadgitlab-ce-c53aad315f89e0eaa44ab680d0b79f38c4590083.tar.gz
Add proper screenshot and comment on the outputdoc_refactor_jira
[ci skip]
Diffstat (limited to 'doc/project_services')
-rw-r--r--doc/project_services/img/jira_issue_closed.pngbin0 -> 92601 bytes
-rw-r--r--doc/project_services/img/jira_issues_workflow.pngbin104791 -> 105237 bytes
-rw-r--r--doc/project_services/jira.md19
3 files changed, 14 insertions, 5 deletions
diff --git a/doc/project_services/img/jira_issue_closed.png b/doc/project_services/img/jira_issue_closed.png
new file mode 100644
index 00000000000..cabec1ae137
--- /dev/null
+++ b/doc/project_services/img/jira_issue_closed.png
Binary files differ
diff --git a/doc/project_services/img/jira_issues_workflow.png b/doc/project_services/img/jira_issues_workflow.png
index 51a1bc10210..28e17be3a84 100644
--- a/doc/project_services/img/jira_issues_workflow.png
+++ b/doc/project_services/img/jira_issues_workflow.png
Binary files differ
diff --git a/doc/project_services/jira.md b/doc/project_services/jira.md
index 2ade54aeaf8..b82e4857814 100644
--- a/doc/project_services/jira.md
+++ b/doc/project_services/jira.md
@@ -167,9 +167,10 @@ Where:
### Closing JIRA issues
JIRA issues can be closed directly from GitLab by using trigger words in
-commits and merge requests. When a commit, which contains the trigger word
-followed by the JIRA issue ID in the commit message, is pushed, GitLab will
-add a comment in the mentioned JIRA issue and immediately close it.
+commits and merge requests. When a commit which contains the trigger word
+followed by the JIRA issue ID in the commit message is pushed, GitLab will
+add a comment in the mentioned JIRA issue and immediately close it (provided
+the transition ID was set up correctly).
There are currently three trigger words, and you can use either one to achieve
the same goal:
@@ -187,7 +188,7 @@ in GitLab. The workflow would be something like this:
1. Create a new branch
1. Fix the bug
-1. Commit the changes and push back to GitLab
+1. Commit the changes and push branch to GitLab
1. Open a new merge request and reference the JIRA issue including one of the
trigger words, e.g.: `Fixes GITLAB-1`, in the description
1. Submit the merge request
@@ -207,9 +208,17 @@ issue look like.
Once this merge request is merged, the JIRA issue will be automatically closed
with a link to the commit that resolved the issue.
-![The GitLab integration user leaves a comment on JIRA](img/jira_service_close_issue.png)
+![The GitLab integration user leaves a comment on JIRA](img/jira_issue_closed.png)
---
+You can see from the above image that there are four references to GitLab:
+
+- The first is from a comment in a specific commit
+- The second one is from the JIRA issue reference in the merge request
+ description
+- The third is from the actual commit that solved the issue
+- And the fourth one is from the commit that the merge request created
+
[services-templates]: ../project_services/services_templates.md "Services templates documentation"
[JIRA Core]: https://www.atlassian.com/software/jira/core "The JIRA Core website"