diff options
Diffstat (limited to 'doc/user/project/integrations/youtrack.md')
| -rw-r--r-- | doc/user/project/integrations/youtrack.md | 47 |
1 files changed, 27 insertions, 20 deletions
diff --git a/doc/user/project/integrations/youtrack.md b/doc/user/project/integrations/youtrack.md index 2ab14a8db2c..a2a468b6fe4 100644 --- a/doc/user/project/integrations/youtrack.md +++ b/doc/user/project/integrations/youtrack.md @@ -1,31 +1,38 @@ # 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 -in the table below. +## Enable the YouTrack integration - | 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. | +To enable YouTrack integration in a 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. +1. Navigate to the project's **Settings > [Integrations](project_services.md#accessing-the-project-services)** page. +1. Click the **YouTrack** service, ensure it's active, and enter the required details on the page as described in the table below. -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. + | Field | Description | + |:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | **Description** | Name for the issue tracker (to differentiate between instances, for example). | + | **Project url** | URL to the project in YouTrack which is being linked to this GitLab project. | + | **Issues url** | 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. | -  +1. Click the **Save changes** button. -## Referencing issues in YouTrack +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. -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`). +## Disable the internal issue tracker -`<PROJECT>` part is included into issue_id and links can point any YouTrack -project (`issues_url` + issue_id) +To disable the internal issue tracker in a project: + +1. Navigate to the project's **Settings > General** page. +1. Expand the [permissions section](../settings/index.md#sharing-and-permissions) and switch the **Issues** toggle to disabled. + +## Referencing YouTrack issues in GitLab + +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`. + +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. |