summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcharlieablett <cablett@gitlab.com>2019-06-06 20:30:42 +1200
committercharlieablett <cablett@gitlab.com>2019-06-06 20:30:42 +1200
commitb0f098eac64936cff8ea1fe60f680d4360e9a16d (patch)
tree717fb191d5c087bf309a3198370ded3a7c0da108
parent82d21efb7e57c5af2388d190dc88314dcc6eb414 (diff)
downloadgitlab-ce-58975-jira-integration-docs-cablett.tar.gz
Apply reviewer feedback for readability58975-jira-integration-docs-cablett
-rw-r--r--doc/user/project/integrations/img/jira_add_permission_scheme.pngbin38913 -> 0 bytes
-rw-r--r--doc/user/project/integrations/jira_server_configuration.md33
2 files changed, 14 insertions, 19 deletions
diff --git a/doc/user/project/integrations/img/jira_add_permission_scheme.png b/doc/user/project/integrations/img/jira_add_permission_scheme.png
deleted file mode 100644
index d527864ac56..00000000000
--- a/doc/user/project/integrations/img/jira_add_permission_scheme.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/integrations/jira_server_configuration.md b/doc/user/project/integrations/jira_server_configuration.md
index 3da76dca447..e9d2980ae10 100644
--- a/doc/user/project/integrations/jira_server_configuration.md
+++ b/doc/user/project/integrations/jira_server_configuration.md
@@ -1,16 +1,14 @@
# Creating a username and password for JIRA server
We need to create a user in Jira which will have access to all projects that
-need to integrate with GitLab. Login to your Jira instance as admin and under
-*Administration*, go to *User Management* and create a new user.
+need to integrate with GitLab.
As an example, we'll create a user named `gitlab` and add it to the `Jira-developers`
group.
NOTE: **Note**
-It is important that the user `gitlab` has 'write' access to projects in Jira.
-
-We have split this stage in steps so it is easier to follow.
+It is important that the Jira user created for the integration is given 'write' access to your Jira projects.
+This is covered in the process below.
1. Log in to your Jira instance as an administrator and under **Jira Administration**
go to **User Management** to create a new user.
@@ -21,37 +19,34 @@ We have split this stage in steps so it is easier to follow.
to projects in Jira. Enter the user's name and a _valid_ e-mail address
since Jira sends a verification e-mail to set up the password.
_**Note:** Jira creates the username automatically by using the e-mail
- prefix. You can change it later, if needed. Our integration does not support SSO (such as SAML). You will need to create
- an HTTP basic authentication password. You can do this by visiting the user
+ prefix. You can change it later, if needed. Our integration does not support SSO (such as SAML).
+ You will need to create an HTTP basic authentication password. You can do this by visiting the user
profile, looking up the username, and setting a password._
![Jira create new user](img/jira_create_new_user.png)
-1. Create a `gitlab-developers` group (We will give write access to this group
- to projects in Jira in a later step). Go to the **Groups** tab on the left, and select **Add group**.
+1. Create a `gitlab-developers` group. (We will give this group write access
+ to Jira projects in a later step). Go to the **Groups** tab on the left, and select **Add group**.
![Jira create new user](img/jira_create_new_group.png)
Give it a name and click **Add group**.
-1. Add the `gitlab` user to the `gitlab-developers` group by clicking **Edit members**
- The `gitlab-developers` group should be selected on the left hand box. Under **Add members to selected group(s)**,
- type in `gitlab`.
+1. Add the `gitlab` user to the `gitlab-developers` group by clicking **Edit members**.
+ The `gitlab-developers` group should be listed in the leftmost box as a selected group.
+ Under **Add members to selected group(s)**, enter `gitlab`.
![Jira add user to group](img/jira_add_user_to_group.png)
- Click **Add selected users** and `gitlab` should appear in the middle box. It
+ Click **Add selected users** and `gitlab` should appear in the **Group member(s)** box. This membership
is saved automatically.
![Jira added user to group](img/jira_added_user_to_group.png)
1. To give the newly-created group 'write' access, you need to create a **Permission Scheme**.
- To do this, click the gear > **Issues**. On the left hand menu, click
- **Permission Schemes**. Click **Add Permission Scheme** and fill in a name
- and (optional) description.
-
- ![Jira add new permission scheme](img/jira_add_permission_scheme.png)
-
+ To do this, click the gear icon and select **Issues**. Then click **Permission Schemes**.
+ Click **Add Permission Scheme** and enter a **Name** and, optionally, a **Description**.
+
1. Once your permission scheme is created, you'll be taken back to the permissions scheme list.
Locate your new permissions scheme and click **Permissions**. Next to **Administer Projects**,
click **Edit**. In the resulting dialog box, select **Group** and select `gitlab-developers`