diff options
| -rw-r--r-- | app/views/shared/issuable/_form.html.haml | 2 | ||||
| -rw-r--r-- | doc/user/project/description_templates.md | 42 | ||||
| -rw-r--r-- | doc/user/project/img/description_templates.png | bin | 0 -> 20444 bytes | |||
| -rw-r--r-- | doc/workflow/README.md | 2 | ||||
| -rw-r--r-- | doc/workflow/description_templates.md | 12 | ||||
| -rw-r--r-- | doc/workflow/img/description_templates.png | bin | 57670 -> 0 bytes |
6 files changed, 44 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..ea7496af089 --- /dev/null +++ b/doc/user/project/description_templates.md @@ -0,0 +1,42 @@ +# Description templates + +>[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've 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. The 'Reset template' button will discard any +changes you made after picking the template and return it to its initial status. + + + +[ce-4981]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/4981 diff --git a/doc/user/project/img/description_templates.png b/doc/user/project/img/description_templates.png Binary files differnew file mode 100644 index 00000000000..c41cc77a94c --- /dev/null +++ b/doc/user/project/img/description_templates.png 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. - - - -_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. diff --git a/doc/workflow/img/description_templates.png b/doc/workflow/img/description_templates.png Binary files differdeleted file mode 100644 index af2e9403826..00000000000 --- a/doc/workflow/img/description_templates.png +++ /dev/null |
