summaryrefslogtreecommitdiff
path: root/doc/user/project/integrations/custom_issue_tracker.md
diff options
context:
space:
mode:
authorVictor Wu <victor@gitlab.com>2017-11-21 15:21:50 +0000
committerSean McGivern <sean@mcgivern.me.uk>2017-11-21 15:21:50 +0000
commit129036b2cf787f30264a99745cb87125b4b925e4 (patch)
treeba137dcbb8ddd51e062b671f01d80a2d266fb1a4 /doc/user/project/integrations/custom_issue_tracker.md
parentf562e69eab0d7bac8ea20d29c3df981289dd8cdb (diff)
downloadgitlab-ce-129036b2cf787f30264a99745cb87125b4b925e4.tar.gz
Custom issue tracker
Diffstat (limited to 'doc/user/project/integrations/custom_issue_tracker.md')
-rw-r--r--doc/user/project/integrations/custom_issue_tracker.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/user/project/integrations/custom_issue_tracker.md b/doc/user/project/integrations/custom_issue_tracker.md
new file mode 100644
index 00000000000..757522c2ae3
--- /dev/null
+++ b/doc/user/project/integrations/custom_issue_tracker.md
@@ -0,0 +1,20 @@
+# Custom Issue Tracker Service
+
+To enable the Custom Issue Tracker integration in a project, navigate to the
+[Integrations page](project_services.md#accessing-the-project-services), click
+the **Customer Issue Tracker** service, and fill in the required details on the page as described
+in the table below.
+
+| Field | Description |
+| ----- | ----------- |
+| `title` | A title for the issue tracker (to differentiate between instances, for example) |
+| `description` | A name for the issue tracker (to differentiate between instances, for example) |
+| `project_url` | Currently unused. Will be changed in a future release. |
+| `issues_url` | The URL to the issue in the issue tracker 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. For example, `https://customissuetracker.com/project-name/:id`. |
+| `new_issue_url` | Currently unused. Will be changed in a future release. |
+
+
+## Referencing issues
+
+Issues are referenced with `#<ID>`, where `<ID>` is a number (example `#143`).
+So with the example above, `#143` would refer to `https://customissuetracker.com/project-name/143`. \ No newline at end of file