diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-11-22 18:25:46 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-11-22 18:25:46 +0000 |
commit | 0c921e3e9c22d3b5da502cc66992d7043cf1c54e (patch) | |
tree | e6ccb0e50aa0ed5ef920debfd7a11ffa932affec /doc/project_services | |
parent | b8980e89aa87901ef17f4fed58802d07ddbb1b6a (diff) | |
parent | 7367744401a04b78fa424b5949f688f6c2cb4c7f (diff) | |
download | gitlab-ce-0c921e3e9c22d3b5da502cc66992d7043cf1c54e.tar.gz |
Merge branch 'docs/jira-update-api-docs' into 'master'
Add changes to JIRA api docs
See merge request !7675
Diffstat (limited to 'doc/project_services')
-rw-r--r-- | doc/project_services/jira.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/project_services/jira.md b/doc/project_services/jira.md index e537a24028c..366e4b2d306 100644 --- a/doc/project_services/jira.md +++ b/doc/project_services/jira.md @@ -97,7 +97,7 @@ in the table below. | Field | Description | | ----- | ----------- | | `URL` | The base URL to the JIRA project which is being linked to this GitLab project. E.g., `https://jira.example.com`. | -| `Project key` | The short, the identifier for your JIRA project, all uppercase. | +| `Project key` | The short identifier for your JIRA project, all uppercase, e.g., `PROJ`. | | `Username` | The user name created in [configuring JIRA step](#configuring-jira). | | `Password` |The password of the user created in [configuring JIRA step](#configuring-jira). | | `JIRA issue transition` | This is the ID of a transition that moves issues to a closed state. You can find this number under JIRA workflow administration ([see screenshot](img/jira_workflow_screenshot.png)). | @@ -121,7 +121,7 @@ ID in GitLab commits and merge requests. When GitLab project has JIRA issue tracker configured and enabled, mentioning JIRA issue in GitLab will automatically add a comment in JIRA issue with the link back to GitLab. This means that in comments in merge requests and commits -referencing an issue, eg. `PROJECT-7`, will add a comment in JIRA issue in the +referencing an issue, e.g., `PROJECT-7`, will add a comment in JIRA issue in the format: ``` @@ -150,11 +150,11 @@ the transition ID was set up correctly). There are currently three trigger words, and you can use either one to achieve the same goal: -- `Resolves GITLAB-1` -- `Closes GITLAB-1` -- `Fixes GITLAB-1` +- `Resolves PROJECT-1` +- `Closes PROJECT-1` +- `Fixes PROJECT-1` -- where `GITLAB-1` the issue ID of the JIRA project. +where `PROJECT-1` is the issue ID of the JIRA project. ### JIRA issue closing example |