summaryrefslogtreecommitdiff
path: root/doc/project_services/redmine.md
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-01-08 15:05:35 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-01-08 15:05:35 +0000
commit255a63564bcb0cf3125be1fbcfe0d9c269e513cf (patch)
tree41dd76b16e95c669476082f39361dd395b6918d0 /doc/project_services/redmine.md
parentec4a4f0623a6892daef75d4b790bc2fec5803b15 (diff)
parent65c474997d18b4978dcca3bafeb2e6c6552227c9 (diff)
downloadgitlab-ce-255a63564bcb0cf3125be1fbcfe0d9c269e513cf.tar.gz
Merge branch 'docs_project_services' into 'master'
Project services and JIRA documentation clean up Closes https://gitlab.com/gitlab-org/gitlab-ee/issues/176 This was first aiming to fix the JIRA references to EE, but as I was going through it, I decided to revamp more. @Haydn once merged here and then Valery merges CE into EE it should be fixed in doc.gitlab.com as well. @dblessing the docs state that we support JIRA 6.x. I see that 7.x is out, should the docs be amended? Also we seem to have a place to document services (http://doc.gitlab.com/ce/project_services/project_services.html), but the JIRA doc is under integration :/ I'd like it to have it moved under `project_services/`, but I guess most customers know the current URL better. See merge request !2345
Diffstat (limited to 'doc/project_services/redmine.md')
-rw-r--r--doc/project_services/redmine.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/project_services/redmine.md b/doc/project_services/redmine.md
new file mode 100644
index 00000000000..b9830ea7c38
--- /dev/null
+++ b/doc/project_services/redmine.md
@@ -0,0 +1,21 @@
+# Redmine Service
+
+Go to your project's **Settings > Services > Redmine** and fill in the required
+details 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 Redmine which is being linked to this GitLab project |
+| `issues_url` | The URL to the issue in Redmine 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 Redmine for the project linked to this GitLab project |
+
+Once you have configured and enabled Redmine:
+
+- the **Issues** link on the GitLab project pages takes you to the appropriate
+ Redmine issue index
+- clicking **New issue** on the project dashboard creates a new Redmine issue
+
+As an example, below is a configuration for a project named gitlab-ci.
+
+![Redmine configuration](img/redmine_configuration.png)