Improve Youtrack documentation for style
This commit is contained in:
parent
08491fb1ad
commit
b1f1a9633d
|
@ -3,9 +3,12 @@
|
|||
GitLab has a great [issue tracker](../user/project/issues/index.md) but you can also use an external one
|
||||
such as Jira, Redmine, YouTrack, or Bugzilla. External issue trackers are configurable per GitLab project.
|
||||
|
||||
Once configured, you can reference external issues using the format CODE-123, where CODE is a unique code
|
||||
for the tracker, and 123 is the issue number in the tracker. These references in GitLab
|
||||
merge requests, commits, or comments are automatically converted to links to the issues.
|
||||
Once configured, you can reference external issues using the format `CODE-123`, where:
|
||||
|
||||
- `CODE` is a unique code for the tracker.
|
||||
- `123` is the issue number in the tracker.
|
||||
|
||||
These references in GitLab merge requests, commits, or comments are automatically converted to links to the issues.
|
||||
|
||||
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.
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 12 KiB |
|
@ -18,9 +18,7 @@
|
|||
|
||||
![Redmine configuration](img/redmine_configuration.png)
|
||||
|
||||
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)
|
||||
1. To disable the internal issue tracking system in a project, navigate to the General page, expand the [permissions](../settings/index.md#sharing-and-permissions) section and switch the **Issues** toggle to disabled.
|
||||
|
||||
## Referencing issues in Redmine
|
||||
|
||||
|
|
|
@ -4,25 +4,29 @@ JetBrains [YouTrack](https://www.jetbrains.com/help/youtrack/standalone/YouTrack
|
|||
|
||||
You can configure YouTrack as an [External Issue Tracker](../../../integration/external-issue-tracker.md) in GitLab.
|
||||
|
||||
## Enable the YouTrack integration in a project
|
||||
## Enable the YouTrack integration
|
||||
|
||||
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.
|
||||
To enable YouTrack integration in a project:
|
||||
|
||||
| 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. |
|
||||
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.
|
||||
|
||||
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.
|
||||
| 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. |
|
||||
|
||||
## Disable the internal issue tracker in a project
|
||||
1. Click the **Save changes** button.
|
||||
|
||||
Navigate to the General page, expand [Permissions](../settings/index.md#sharing-and-permissions), and switch the Issues toggle to disabled.
|
||||
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.
|
||||
|
||||
![Issue configuration](img/issue_configuration.png)
|
||||
## Disable the internal issue tracker
|
||||
|
||||
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
|
||||
|
||||
|
@ -30,5 +34,5 @@ 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.
|
||||
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