From 2f1e4740a0be21d1e024ba4ced83b818ccc3ed67 Mon Sep 17 00:00:00 2001 From: Tristan Williams <2390023-tristan@users.noreply.gitlab.com> Date: Mon, 8 Jul 2019 05:47:37 +0000 Subject: Refresh screenshots Current screenshots are from an older version of Jira and GitLab. --- .../project/integrations/img/jira_api_token.png | Bin 61394 -> 21318 bytes .../integrations/img/jira_api_token_menu.png | Bin 25056 -> 41876 bytes .../integrations/img/jira_issue_reference.png | Bin 18399 -> 64064 bytes .../integrations/img/jira_merge_request_close.png | Bin 21172 -> 64305 bytes .../img/jira_service_close_comment.png | Bin 11890 -> 0 bytes .../integrations/img/jira_service_close_issue.png | Bin 30570 -> 29632 bytes .../project/integrations/img/jira_service_page.png | Bin 30395 -> 70807 bytes doc/user/project/integrations/jira.md | 26 ++++++++++----------- .../integrations/jira_cloud_configuration.md | 16 +++++++------ 9 files changed, 22 insertions(+), 20 deletions(-) delete mode 100644 doc/user/project/integrations/img/jira_service_close_comment.png diff --git a/doc/user/project/integrations/img/jira_api_token.png b/doc/user/project/integrations/img/jira_api_token.png index 4fa7a46854e..29689271bf7 100644 Binary files a/doc/user/project/integrations/img/jira_api_token.png and b/doc/user/project/integrations/img/jira_api_token.png differ diff --git a/doc/user/project/integrations/img/jira_api_token_menu.png b/doc/user/project/integrations/img/jira_api_token_menu.png index 14037bd0b47..1aca1d78f36 100644 Binary files a/doc/user/project/integrations/img/jira_api_token_menu.png and b/doc/user/project/integrations/img/jira_api_token_menu.png differ diff --git a/doc/user/project/integrations/img/jira_issue_reference.png b/doc/user/project/integrations/img/jira_issue_reference.png index 72c81460df7..a3e80c1b054 100644 Binary files a/doc/user/project/integrations/img/jira_issue_reference.png and b/doc/user/project/integrations/img/jira_issue_reference.png differ diff --git a/doc/user/project/integrations/img/jira_merge_request_close.png b/doc/user/project/integrations/img/jira_merge_request_close.png index 0f82ceba557..1c089c94207 100644 Binary files a/doc/user/project/integrations/img/jira_merge_request_close.png and b/doc/user/project/integrations/img/jira_merge_request_close.png differ diff --git a/doc/user/project/integrations/img/jira_service_close_comment.png b/doc/user/project/integrations/img/jira_service_close_comment.png deleted file mode 100644 index 9af0d38f098..00000000000 Binary files a/doc/user/project/integrations/img/jira_service_close_comment.png and /dev/null differ diff --git a/doc/user/project/integrations/img/jira_service_close_issue.png b/doc/user/project/integrations/img/jira_service_close_issue.png index c85b1d1dd97..73d6498192c 100644 Binary files a/doc/user/project/integrations/img/jira_service_close_issue.png and b/doc/user/project/integrations/img/jira_service_close_issue.png differ diff --git a/doc/user/project/integrations/img/jira_service_page.png b/doc/user/project/integrations/img/jira_service_page.png index 377b69d9d06..80dd65ea24e 100644 Binary files a/doc/user/project/integrations/img/jira_service_page.png and b/doc/user/project/integrations/img/jira_service_page.png differ diff --git a/doc/user/project/integrations/jira.md b/doc/user/project/integrations/jira.md index 8f2e5a55b5f..ca990ee6c32 100644 --- a/doc/user/project/integrations/jira.md +++ b/doc/user/project/integrations/jira.md @@ -39,21 +39,17 @@ a GitLab project with any single Jira project. If you have one Jira instance, you can pre-fill the settings page with a default template. See the [Services Templates][services-templates] docs. -Configuration happens via user name and password. Connecting to a Jira Server -via CAS is not possible. - -In order to enable the Jira service in GitLab, you need to first configure the -project in Jira and then enter the correct values in GitLab. +In order to enable the Jira service in GitLab, you need to first configure the project in Jira and then enter the correct values in GitLab. ### Configuring Jira -When connecting to **Jira Server**, which supports basic authentication, a **username and password** are required. Check the link below and proceed to the next step: +#### Jira Server -- [Setting up a user in Jira Server](jira_server_configuration.md) +When connecting to **Jira Server**, which supports basic authentication, a **username and password** are required. Note that connecting to a Jira server via CAS is not possible. [Set up a user in Jira Server](jira_server_configuration.md) first and then proceed to [Configuring GitLab](#configuring-gitlab). -When connecting to **Jira Cloud**, which supports authentication via API token, an **email and API token**, are required. Check the link below and proceed to the next step: +#### Jira Cloud -- [Setting up a user in Jira Cloud](jira_cloud_configuration.md) +When connecting to **Jira Cloud**, which supports authentication via API token, an **email and API token**, are required. [Set up a user in Jira Cloud](jira_cloud_configuration.md) first and then proceed to [Configuring GitLab](#configuring-gitlab). ### Configuring GitLab @@ -68,7 +64,7 @@ When connecting to **Jira Cloud**, which supports authentication via API token, > to enable Basic Auth. The cookie being added to each request is `OBBasicAuth` with > a value of `fromDialog`. -To enable Jira integration in a project, navigate to the +To enable the Jira integration in a project, navigate to the [Integrations page](project_services.md#accessing-the-project-services), click the **Jira** service, and fill in the required details on the page as described in the table below. @@ -127,6 +123,12 @@ ENTITY_TITLE ![example of mentioning or closing the Jira issue](img/jira_issue_reference.png) +For example, the following commit will reference the Jira issue with `PROJECT-1` as its ID: + +```bash +git commit -m "PROJECT-1 Fix spelling and grammar" +``` + ### Closing Jira Issues Jira issues can be closed directly from GitLab by using trigger words in @@ -142,7 +144,7 @@ the same goal: - `Closes PROJECT-1` - `Fixes PROJECT-1` -where `PROJECT-1` is the issue ID of the Jira project. +where `PROJECT-1` is the ID of the Jira issue. > **Notes:** > @@ -174,8 +176,6 @@ with a link to the commit that resolved the issue. ![The GitLab integration closes Jira issue](img/jira_service_close_issue.png) -![The GitLab integration creates a comment and a link on Jira issue.](img/jira_service_close_comment.png) - ## Troubleshooting If these features do not work as expected, it is likely due to a problem with the way the integration settings were configured. diff --git a/doc/user/project/integrations/jira_cloud_configuration.md b/doc/user/project/integrations/jira_cloud_configuration.md index 614f05d5b7e..5a5ba2dd168 100644 --- a/doc/user/project/integrations/jira_cloud_configuration.md +++ b/doc/user/project/integrations/jira_cloud_configuration.md @@ -3,16 +3,18 @@ An API token is needed when integrating with Jira Cloud, follow the steps below to create one: -1. Log in to with your email. -1. **Click API tokens**, then **Create API token**. +1. Log in to with your email address. + + NOTE: **Note** + It is important that the user associated with this email address has *write* access + to projects in Jira. + +2. Click **Create API token**. ![Jira API token](img/jira_api_token_menu.png) ![Jira API token](img/jira_api_token.png) -1. Make sure to write down your new API token as you will need it in the next [steps](jira.md#configuring-gitlab). - -NOTE: **Note** -It is important that the user associated with this email has 'write' access to projects in Jira. +1. Click **Copy to clipboard**, or click **View** and write down the new API token. It is required when [configuring GitLab](jira.md#configuring-gitlab). -The Jira configuration is complete. You are going to need this newly created token and the email you used to log in, when [configuring GitLab in the next section](jira.md#configuring-gitlab). +The Jira configuration is complete. You need the newly created token, and the associated email address, when [configuring GitLab](jira.md#configuring-gitlab) in the next section. -- cgit v1.2.1