summaryrefslogtreecommitdiff
path: root/doc/user/project/integrations/youtrack.md
diff options
context:
space:
mode:
authorYauhen Kotau <yauhen.kotau@psa-software.com>2019-02-18 20:08:36 +0300
committerYauhen Kotau <yauhen.kotau@psa-software.com>2019-02-18 20:08:36 +0300
commit04daa0b9701cd5b53c3c1fd6529aba05e4189114 (patch)
tree2680c1b9eca8317168018e2219d7fb718e32848f /doc/user/project/integrations/youtrack.md
parentfe10964a6884162b9272ec3a32a5736c2a997ab2 (diff)
downloadgitlab-ce-04daa0b9701cd5b53c3c1fd6529aba05e4189114.tar.gz
Added YouTrack integration
Fixes gitlab-org/gitlab-ce#42595
Diffstat (limited to 'doc/user/project/integrations/youtrack.md')
-rw-r--r--doc/user/project/integrations/youtrack.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/user/project/integrations/youtrack.md b/doc/user/project/integrations/youtrack.md
new file mode 100644
index 00000000000..85c339d5fa9
--- /dev/null
+++ b/doc/user/project/integrations/youtrack.md
@@ -0,0 +1,28 @@
+# YouTrack Service
+
+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
+in the table below.
+
+ | Field | Description |
+ | ----- | ----------- |
+ | `description` | A name for the issue tracker (to differentiate between instances, for example) |
+ | `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. |
+ | `new_issue_url` | This is the URL to create a new issue in YouTrack for the project linked to this GitLab project. **This is currently not being used and will be removed in a future release.** |
+
+ 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.
+
+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.
+
+ ![Issue configuration](img/issue_configuration.png)
+
+## Referencing issues in YouTrack
+
+Issues in YouTrack can be referenced as `<PROJECT>-<ID>` where `<PROJECT>`
+starts with a capital letter which is then followed by capital letters, numbers
+or underscores, and `<ID>` is a number (example `API_32-143`).
+
+`<PROJECT>` part is included into issue_id and links can point any YouTrack
+project (`issues_url` + issue_id)