Merge branch 'review-youtrack-docs' into 'master'
YouTrack docs review Closes #58225 See merge request gitlab-org/gitlab-ce!26454
This commit is contained in:
commit
08491fb1ad
|
@ -1,14 +1,14 @@
|
||||||
# External issue tracker
|
# External issue tracker
|
||||||
|
|
||||||
GitLab has a great issue tracker but you can also use an external one such as
|
GitLab has a great [issue tracker](../user/project/issues/index.md) but you can also use an external one
|
||||||
Jira, Redmine, YouTrack, or Bugzilla. Issue trackers are configurable per GitLab project
|
such as Jira, Redmine, YouTrack, or Bugzilla. External issue trackers are configurable per GitLab project.
|
||||||
and allow you to do the following:
|
|
||||||
|
|
||||||
- you can reference these external issues inside GitLab interface
|
Once configured, you can reference external issues using the format CODE-123, where CODE is a unique code
|
||||||
(merge requests, commits, comments) and they will be automatically converted
|
for the tracker, and 123 is the issue number in the tracker. These references in GitLab
|
||||||
into links
|
merge requests, commits, or comments are automatically converted to links to the issues.
|
||||||
|
|
||||||
You can have enabled both external and internal GitLab issue trackers in parallel. The **Issues** link always opens the internal issue tracker and in case the internal issue tracker is disabled the link is not visible in the menu.
|
You can keep GitLab's issue tracker enabled in parallel or disable it. When enabled, the **Issues** link in the
|
||||||
|
GitLab menu always opens the internal issue tracker. When disabled, the link is not visible in the menu.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,13 @@
|
||||||
# YouTrack Service
|
# YouTrack Service
|
||||||
|
|
||||||
JetBrains YouTrack is a web-based issue tracking and project management platform.
|
JetBrains [YouTrack](https://www.jetbrains.com/help/youtrack/standalone/YouTrack-Documentation.html) 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.
|
|
||||||
|
|
||||||
|
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
|
## Enable the YouTrack integration in a project
|
||||||
[Integrations page](project_services.md#accessing-the-project-services), click
|
|
||||||
the **YouTrack** service, and fill in the required details on the page as described
|
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.
|
in the table below.
|
||||||
|
|
||||||
| Field | Description |
|
| 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 |
|
| `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. |
|
| `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.
|
||||||
|
|
||||||
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.
|
## Disable the internal issue tracker in a project
|
||||||
|
|
||||||
![Issue configuration](img/issue_configuration.png)
|
Navigate to the General page, expand [Permissions](../settings/index.md#sharing-and-permissions), and switch the Issues toggle to disabled.
|
||||||
|
|
||||||
## Referencing issues in YouTrack
|
![Issue configuration](img/issue_configuration.png)
|
||||||
|
|
||||||
Issues in YouTrack can be referenced as `<PROJECT>-<ID>` where `<PROJECT>`
|
## Referencing YouTrack issues in GitLab
|
||||||
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`).
|
|
||||||
|
|
||||||
`<PROJECT>` part is included into issue_id and links can point any YouTrack
|
Issues in YouTrack can be referenced as `<PROJECT>-<ID>`. `<PROJECT>`
|
||||||
project (`issues_url` + issue_id)
|
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.
|
||||||
|
|
Loading…
Reference in New Issue