summaryrefslogtreecommitdiff
path: root/doc/user/project/integrations/youtrack.md
diff options
context:
space:
mode:
authorMike Lewis <mlewis@gitlab.com>2019-03-22 02:39:00 +0000
committerEvan Read <eread@gitlab.com>2019-03-22 02:39:00 +0000
commit53d7dccf8b198cd51a9524a098e7e3343dc2ddd2 (patch)
tree85ff768f02cb7b3598fc4f4db7af48327e537107 /doc/user/project/integrations/youtrack.md
parentd81f048796780b97270c3cf1c9bff00db9ad8ca3 (diff)
downloadgitlab-ce-53d7dccf8b198cd51a9524a098e7e3343dc2ddd2.tar.gz
YouTrack docs review
Diffstat (limited to 'doc/user/project/integrations/youtrack.md')
-rw-r--r--doc/user/project/integrations/youtrack.md31
1 files changed, 17 insertions, 14 deletions
diff --git a/doc/user/project/integrations/youtrack.md b/doc/user/project/integrations/youtrack.md
index 2ab14a8db2c..0d0237c2925 100644
--- a/doc/user/project/integrations/youtrack.md
+++ b/doc/user/project/integrations/youtrack.md
@@ -1,12 +1,13 @@
# YouTrack Service
-JetBrains YouTrack is a web-based issue tracking and project management platform.
-Please refer official [documentation](https://www.jetbrains.com/help/youtrack/standalone/YouTrack-Documentation.html) for details about YouTrack itself.
+JetBrains [YouTrack](https://www.jetbrains.com/help/youtrack/standalone/YouTrack-Documentation.html) is a web-based issue tracking and project management platform.
+You can configure YouTrack as an [External Issue Tracker](../../../integration/external-issue-tracker.md) in GitLab.
-1. To enable the YouTrack integration in a project, navigate to the
-[Integrations page](project_services.md#accessing-the-project-services), click
-the **YouTrack** service, and fill in the required details on the page as described
+## Enable the YouTrack integration in a project
+
+Navigate to the [Integrations page](project_services.md#accessing-the-project-services), click
+the **YouTrack** service, and enter the required details on the page as described
in the table below.
| Field | Description |
@@ -15,17 +16,19 @@ in the table below.
| `project_url` | The URL to the project in YouTrack which is being linked to this GitLab project |
| `issues_url` | The URL to the issue in YouTrack project that is linked to this GitLab project. Note that the `issues_url` requires `:id` in the URL. This ID is used by GitLab as a placeholder to replace the issue number. |
- Once you have configured and enabled YouTrack you'll see the YouTrack link on the GitLab project pages that takes you to the appropriate YouTrack project.
+Once you have configured and enabled YouTrack you'll see the YouTrack link on the GitLab project pages that takes you to the appropriate YouTrack project.
+
+## Disable the internal issue tracker in a project
-1. To disable the internal issue tracking system in a project, navigate to the General page, expand [Permissions](../settings/index.md#sharing-and-permissions), and slide the Issues switch invalid.
+Navigate to the General page, expand [Permissions](../settings/index.md#sharing-and-permissions), and switch the Issues toggle to disabled.
- ![Issue configuration](img/issue_configuration.png)
+![Issue configuration](img/issue_configuration.png)
-## Referencing issues in YouTrack
+## Referencing YouTrack issues in GitLab
-Issues in YouTrack can be referenced as `<PROJECT>-<ID>` where `<PROJECT>`
-starts with a capital letter which is then followed by capital or lower case
-letters, numbers or underscores, and `<ID>` is a number (example `Api_32-143`).
+Issues in YouTrack can be referenced as `<PROJECT>-<ID>`. `<PROJECT>`
+must start with a capital letter and can then be followed by capital or lower case
+letters, numbers or underscores. `<ID>` is a number. An example reference is `YT-101` or `Api_32-143`.
-`<PROJECT>` part is included into issue_id and links can point any YouTrack
-project (`issues_url` + issue_id)
+References to <PROJECT>-<ID> in merge requests, commits, or comments are automatically linked to the YouTrack issue URL.
+For more information, see the [External Issue Tracker](../../../integration/external-issue-tracker.md) documentation.