Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
f67adf58
Commit
f67adf58
authored
Aug 17, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Refactor description templates documentation
parent
fc032230
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
43 additions
and
1 deletion
+43
-1
app/views/shared/issuable/_form.html.haml
app/views/shared/issuable/_form.html.haml
+1
-1
doc/user/project/description_templates.md
doc/user/project/description_templates.md
+41
-0
doc/user/project/img/description_templates.png
doc/user/project/img/description_templates.png
+0
-0
doc/workflow/README.md
doc/workflow/README.md
+1
-0
No files found.
app/views/shared/issuable/_form.html.haml
View file @
f67adf58
...
...
@@ -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
...
...
doc/user/project/description_templates.md
0 → 100644
View file @
f67adf58
# 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
doc/user/project/img/description_templates.png
0 → 100644
View file @
f67adf58
56.3 KB
doc/workflow/README.md
View file @
f67adf58
...
...
@@ -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
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment