Commit e18fff6f authored by Nick Gaskill's avatar Nick Gaskill

Merge branch 'msj-crosslink-template-docs' into 'master'

Add crosslinks in templates docs

See merge request gitlab-org/gitlab!52589
parents 0a4cdd86 477c461a
...@@ -730,6 +730,9 @@ To enable this feature, navigate to the group settings page, expand the ...@@ -730,6 +730,9 @@ To enable this feature, navigate to the group settings page, expand the
![Group file template settings](img/group_file_template_settings.png) ![Group file template settings](img/group_file_template_settings.png)
To learn how to create templates for issues and merge requests, visit
[Description templates](../project/description_templates.md).
#### Group-level project templates **(PREMIUM)** #### Group-level project templates **(PREMIUM)**
Define project templates at a group level by setting a group as the template source. Define project templates at a group level by setting a group as the template source.
......
...@@ -6,16 +6,13 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,16 +6,13 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Description templates # Description templates
>[Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/4981) in GitLab 8.11. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/4981) in GitLab 8.11.
We all know that a properly submitted issue is more likely to be addressed in We all know that a properly submitted issue is more likely to be addressed in
a timely manner by the developers of a project. a timely manner by the developers of a project.
Description templates allow you to define context-specific templates for issue With description templates, you can define context-specific templates for issue and merge request
and merge request description fields for your project, as well as help filter description fields for your project, and filter out unnecessary noise from issues.
out a lot of unnecessary noise from issues.
## Overview
By using the description templates, users that create a new issue or merge 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 request can select a description template to help them communicate with other
...@@ -28,7 +25,10 @@ Description templates must be written in [Markdown](../markdown.md) and stored ...@@ -28,7 +25,10 @@ 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 under a directory named `.gitlab`. Only the
templates of the default branch are taken into account. templates of the default branch are taken into account.
## Use-cases To learn how to create templates for various file types in groups, visit
[Group file templates](../group/index.md#group-file-templates).
## Use cases
- Add a template to be used in every issue for a specific project, - Add a template to be used in every issue for a specific project,
giving instructions and guidelines, requiring for information specific to that subject. giving instructions and guidelines, requiring for information specific to that subject.
...@@ -80,17 +80,17 @@ to the issue description field. The **Reset template** button discards any ...@@ -80,17 +80,17 @@ to the issue description field. The **Reset template** button discards any
changes you made after picking the template and returns it to its initial status. changes you made after picking the template and returns it to its initial status.
NOTE: NOTE:
You can create short-cut links to create an issue using a designated template. For example: `https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Feature%20proposal`. You can create shortcut links to create an issue using a designated template.
For example: `https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Feature%20proposal`.
![Description templates](img/description_templates.png) ![Description templates](img/description_templates.png)
## Setting a default template for merge requests and issues **(STARTER)** ## Setting a default template for merge requests and issues **(STARTER)**
> - This feature was introduced before [description templates](#overview) and is available in [GitLab Starter](https://about.gitlab.com/pricing/). It can be enabled in the project's settings. > - Templates for merge requests [introduced](https://gitlab.com/gitlab-org/gitlab/commit/7478ece8b48e80782b5465b96c79f85cc91d391b) in GitLab 6.9.
> - Templates for issues were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28) in GitLab EE 8.1. > - Templates for issues [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28) in GitLab 8.1.
> - Templates for merge requests were [introduced](https://gitlab.com/gitlab-org/gitlab/commit/7478ece8b48e80782b5465b96c79f85cc91d391b) in GitLab EE 6.9.
The visibility of issues and/or merge requests should be set to either "Everyone The visibility of issues or merge requests should be set to either "Everyone
with access" or "Only Project Members" in your project's **Settings / Visibility, project features, permissions** section, otherwise the with access" or "Only Project Members" in your project's **Settings / Visibility, project features, permissions** section, otherwise the
template text areas don't show. This is the default behavior, so in most cases template text areas don't show. This is the default behavior, so in most cases
you should be fine. you should be fine.
...@@ -113,52 +113,46 @@ pre-filled with the text you entered in the template(s). ...@@ -113,52 +113,46 @@ pre-filled with the text you entered in the template(s).
## Description template example ## Description template example
We make use of Description Templates for Issues and Merge Requests within the GitLab Community We make use of description templates for issues and merge requests in the GitLab project.
Edition project. Please refer to the [`.gitlab` folder](https://gitlab.com/gitlab-org/gitlab/tree/master/.gitlab) For some examples, refer to the [`.gitlab` folder](https://gitlab.com/gitlab-org/gitlab/tree/master/.gitlab).
for some examples.
NOTE: NOTE:
It's possible to use [quick actions](quick_actions.md) within description templates to quickly add 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 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. 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:
```plaintext ```markdown
Summary ## Summary
(Summarize the bug encountered concisely) (Summarize the bug encountered concisely)
## Steps to reproduce
Steps to reproduce
(How one can reproduce the issue - this is very important) (How one can reproduce the issue - this is very important)
## Example Project
Example Project (If possible, please create an example project here on GitLab.com that exhibits the problematic
behavior, and link to it here in the bug report.
(If possible, please create an example project here on GitLab.com that exhibits the problematic behaviour, and link to it here in the bug report) If you are using an older version of GitLab, this will also determine whether the bug has been fixed
in a more recent version)
(If you are using an older version of GitLab, this will also determine whether the bug has been fixed in a more recent version)
## What is the current bug behavior?
What is the current bug behavior?
(What actually happens) (What actually happens)
## What is the expected correct behavior?
What is the expected correct behavior?
(What you should see instead) (What you should see instead)
## Relevant logs and/or screenshots
Relevant logs and/or screenshots (Paste any relevant logs - please use code blocks (```) to format console output, logs, and code, as
it's very hard to read otherwise.)
(Paste any relevant logs - please use code blocks (```) to format console output,
logs, and code as it's very hard to read otherwise.)
Possible fixes ## Possible fixes
(If you can, link to the line of code that might be responsible for the problem) (If you can, link to the line of code that might be responsible for the problem)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment