summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-08-17 13:27:14 +0300
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-08-18 09:13:05 +0300
commit163c4f5658d0b58dd5925936b3b5498adcf60fb7 (patch)
tree4408e373e5b155280fa1bc15a7d92f0629ecada1
parent59fa031e6f7d5a1b658c370f581c4caaf4493150 (diff)
downloadgitlab-ce-163c4f5658d0b58dd5925936b3b5498adcf60fb7.tar.gz
Refactor description templates documentation
-rw-r--r--app/views/shared/issuable/_form.html.haml2
-rw-r--r--doc/user/project/description_templates.md41
-rw-r--r--doc/user/project/img/description_templates.png (renamed from doc/workflow/img/description_templates.png)bin57670 -> 57670 bytes
-rw-r--r--doc/workflow/README.md2
-rw-r--r--doc/workflow/description_templates.md12
5 files changed, 43 insertions, 14 deletions
diff --git a/app/views/shared/issuable/_form.html.haml b/app/views/shared/issuable/_form.html.haml
index 210b43c7e0b..9e2e096d5f9 100644
--- a/app/views/shared/issuable/_form.html.haml
+++ b/app/views/shared/issuable/_form.html.haml
@@ -42,7 +42,7 @@
- if can_add_template?(issuable)
%p.help-block
Add
- = link_to "issuable templates", help_page_path('workflow/description_templates')
+ = link_to "description templates", help_page_path('user/project/description_templates')
to help your contributors communicate effectively!
.form-group.detail-page-description
diff --git a/doc/user/project/description_templates.md b/doc/user/project/description_templates.md
new file mode 100644
index 00000000000..5f1cd126425
--- /dev/null
+++ b/doc/user/project/description_templates.md
@@ -0,0 +1,41 @@
+# Description templates
+
+>**Note:** [Introduced][ce-4981] in GitLab 8.11.
+
+Description templates allow you to define context-specific templates for issue
+and merge request description fields for your project.
+
+## Overview
+
+By using the description templates, users that create a new issue or merge
+request can select a description template to help them communicate with other
+contributors effectively.
+
+Every GitLab project can define its own set of description templates as they
+are added to the root directory of a GitLab project's repository.
+
+Description templates must be written in [Markdown](../markdown.md) and stored
+in your project's repository under a directory named `.gitlab`. Only the
+templates of the default branch will be taken into account.
+
+## Creating issue templates
+
+Create a new Markdown (`.md`) file inside the `.gitlab/issue_templates/`
+directory in your repository. Commit and push to your default branch.
+
+## Creating merge request templates
+
+Similarly to issue templates, create a new Markdown (`.md`) file inside the
+`.gitlab/merge_request_templates/` directory in your repository. Commit and
+push to your default branch.
+
+## Using the templates
+
+Let's take for example that you have created the file `.gitlab/issue_templates/bug.md`.
+This will enable the `bug` dropdown option when creating or editing issues. When
+`bug` is selected, the content from the `bug.md` template file will be copied
+to the issue description field.
+
+![Description templates](img/description_templates.png)
+
+[ce-4981]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/4981
diff --git a/doc/workflow/img/description_templates.png b/doc/user/project/img/description_templates.png
index af2e9403826..af2e9403826 100644
--- a/doc/workflow/img/description_templates.png
+++ b/doc/user/project/img/description_templates.png
Binary files differ
diff --git a/doc/workflow/README.md b/doc/workflow/README.md
index 993349e5b46..3055411c484 100644
--- a/doc/workflow/README.md
+++ b/doc/workflow/README.md
@@ -2,6 +2,7 @@
- [Authorization for merge requests](authorization_for_merge_requests.md)
- [Change your time zone](timezone.md)
+- [Description templates](../user/project/description_templates.md)
- [Feature branch workflow](workflow.md)
- [GitLab Flow](gitlab_flow.md)
- [Groups](groups.md)
@@ -17,7 +18,6 @@
- [Share projects with other groups](share_projects_with_other_groups.md)
- [Web Editor](web_editor.md)
- [Releases](releases.md)
-- [Issuable Templates](issuable_templates.md)
- [Milestones](milestones.md)
- [Merge Requests](merge_requests.md)
- [Revert changes](revert_changes.md)
diff --git a/doc/workflow/description_templates.md b/doc/workflow/description_templates.md
deleted file mode 100644
index 9514564af02..00000000000
--- a/doc/workflow/description_templates.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Description templates
-
-Description templates allow you to define context-specific templates for issue and merge request description fields for your project. When in use, users that create a new issue or merge request can select a description template to help them communicate with other contributors effectively.
-
-Every GitLab project can define its own set of description templates as they are added to the root directory of a GitLab project's repository.
-
-Description templates are written in markdown _(`.md`)_ and stored in your projects repository under the `/.gitlab/issue_templates/` and `/.gitlab/merge_request_templates/` directories.
-
-![Description templates](img/description_templates.png)
-
-_Example:_
-`/.gitlab/issue_templates/bug.md` will enable the `bug` dropdown option for new issues. When `bug` is selected, the content from the `bug.md` template file will be copied to the issue description field.