summaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-03-12 09:09:06 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2021-03-12 09:09:06 +0000
commit3159925155a86dfd41000c1467576927c18c8f58 (patch)
treed9c4673de198ac20e4e310ad299636649e47d2a8 /doc/user
parent8ccbb53e68d2830e766e1cae4e9d158840d115b6 (diff)
downloadgitlab-ce-3159925155a86dfd41000c1467576927c18c8f58.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/project/description_templates.md37
-rw-r--r--doc/user/project/img/description_templates_issue_settings.pngbin9315 -> 0 bytes
-rw-r--r--doc/user/project/img/description_templates_merge_request_settings.pngbin49367 -> 0 bytes
3 files changed, 22 insertions, 15 deletions
diff --git a/doc/user/project/description_templates.md b/doc/user/project/description_templates.md
index e3fa7ca6dc0..2267cb55f16 100644
--- a/doc/user/project/description_templates.md
+++ b/doc/user/project/description_templates.md
@@ -20,7 +20,7 @@ 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
+in your project's repository in the `.gitlab` directory. Only the
templates of the default branch are taken into account.
To learn how to create templates for various file types in groups, visit
@@ -28,10 +28,14 @@ To learn how to create templates for various file types in groups, visit
## Use cases
+These are some situations when you might find description templates useful:
+
+- You can create issues and merge request templates for different
+ stages of your workflow, for example, feature proposal, feature improvement, or a bug report.
- Add a template to be used in every issue for a specific project,
giving instructions and guidelines, requiring for information specific to that subject.
For example, if you have a project for tracking new blog posts, you can require the
- title, outlines, author name, author social media information, and so on.
+ title, outlines, author name, and author social media information.
- Following the previous example, you can make a template for every MR submitted
with a new blog post, requiring information about the post date, front matter data,
images guidelines, link to the related issue, reviewer name, and so on.
@@ -130,21 +134,23 @@ with access" or "Only Project Members" in your project's **Settings / Visibility
template text areas don't show. This is the default behavior, so in most cases
you should be fine.
+To set a default description template for merge requests:
+
1. Go to your project's **Settings**.
-1. Click **Expand** under the **Merge requests** header.
+1. Select **Expand** under the **Merge requests** header.
1. Fill in the **Default description template for merge requests** text area.
-1. Click **Expand** under **Default issue template**.
-1. Fill in the **Default description template for issues** text area.
- Since GitLab merge request and issues support [Markdown](../markdown.md), you can use it to format
- headings, lists, and so on.
+1. Select **Save changes**.
+
+To set a default description template for issues:
-![Default merge request description templates](img/description_templates_merge_request_settings.png)
+1. Select **Expand** under **Default issue template**.
+1. Fill in the **Default description template for issues** text area.
-![Default issue description templates](img/description_templates_issue_settings.png)
+Because GitLab merge request and issues support [Markdown](../markdown.md), you can use it to format
+headings, lists, and so on.
-After you add the description, hit **Save changes** for the settings to take
-effect. Now, every time a new merge request or issue is created, it is
-pre-filled with the text you entered in the template(s).
+Now, every time a new merge request or issue is created, it's pre-filled with the text you entered
+in the templates.
[GitLab versions 13.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/885)
provide `issues_template` and `merge_requests_template` attributes in the
@@ -152,15 +158,16 @@ provide `issues_template` and `merge_requests_template` attributes in the
## Description template example
-We make use of description templates for issues and merge requests in the GitLab project.
-For some examples, refer to the [`.gitlab` folder](https://gitlab.com/gitlab-org/gitlab/tree/master/.gitlab).
+We use description templates for issues and merge requests in the
+[`.gitlab` folder](https://gitlab.com/gitlab-org/gitlab/tree/master/.gitlab) of the
+GitLab project, which you can refer to for some examples.
NOTE:
It's possible to use [quick actions](quick_actions.md) in description templates to quickly add
labels, assignees, and milestones. The quick actions are only executed if the user submitting
the issue or merge request has the permissions to perform the relevant actions.
-Here is an example of a Bug report template:
+Here is an example of a bug report template:
```markdown
## Summary
diff --git a/doc/user/project/img/description_templates_issue_settings.png b/doc/user/project/img/description_templates_issue_settings.png
deleted file mode 100644
index 7f354f7c288..00000000000
--- a/doc/user/project/img/description_templates_issue_settings.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/img/description_templates_merge_request_settings.png b/doc/user/project/img/description_templates_merge_request_settings.png
deleted file mode 100644
index 587367bf2fe..00000000000
--- a/doc/user/project/img/description_templates_merge_request_settings.png
+++ /dev/null
Binary files differ