diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-01 06:07:57 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-01 06:07:57 +0300 |
commit | 1dffba3bd853076efc1107b2dd63e221e75a210c (patch) | |
tree | 7d95f222bad46bacb4cb7490e44ce7cf51b6e2b7 /doc/user/project | |
parent | 396ad86100541bed6bc9960541a7dcddfaddd6de (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/project')
-rw-r--r-- | doc/user/project/badges.md | 8 | ||||
-rw-r--r-- | doc/user/project/description_templates.md | 48 | ||||
-rw-r--r-- | doc/user/project/issue_board.md | 43 |
3 files changed, 47 insertions, 52 deletions
diff --git a/doc/user/project/badges.md b/doc/user/project/badges.md index db882cb25d5..6994f16cf52 100644 --- a/doc/user/project/badges.md +++ b/doc/user/project/badges.md @@ -4,8 +4,9 @@ Badges are a unified way to present condensed pieces of information about your projects. They consist of a small image and additionally a URL that the image -points to. Examples for badges can be the [pipeline status], [test coverage], -or ways to contact the project maintainers. +points to. Examples for badges can be the [pipeline status](../../ci/pipelines/settings.md#pipeline-status-badge), +[test coverage](../../ci/pipelines/settings.md#test-coverage-report-badge), or ways to contact the +project maintainers. ![Badges on Project overview page](img/project_overview_badges.png) @@ -73,6 +74,3 @@ using these placeholders if the information is sensitive. You can also configure badges via the GitLab API. As in the settings, there is a distinction between endpoints for badges on the [project level](../../api/project_badges.md) and [group level](../../api/group_badges.md). - -[pipeline status]: ../../ci/pipelines/settings.md#pipeline-status-badge -[test coverage]: ../../ci/pipelines/settings.md#test-coverage-report-badge diff --git a/doc/user/project/description_templates.md b/doc/user/project/description_templates.md index 84b74692725..a02dc016f03 100644 --- a/doc/user/project/description_templates.md +++ b/doc/user/project/description_templates.md @@ -1,6 +1,6 @@ # Description templates ->[Introduced][ce-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 a timely manner by the developers of a project. @@ -27,12 +27,12 @@ templates of the default branch will be taken into account. - 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, etc. + title, outlines, author name, author social media information, and so on. - Following the previous example, you can make a template for every MR submitted with a new blog post, requiring information about the post date, frontmatter data, - images guidelines, link to the related issue, reviewer name, etc. + images guidelines, link to the related issue, reviewer name, and so on. - You can also create issues and merge request templates for different - stages of your workflow, e.g., feature proposal, feature improvement, bug report, etc. + stages of your workflow, for example, feature proposal, feature improvement, or a bug report. ## Creating issue templates @@ -57,25 +57,25 @@ changes you made after picking the template and return it to its initial status. ## Setting a default template for merge requests and issues **(STARTER)** -> **Notes:** -> -> - This feature was introduced before [description templates](#overview) and is -> available in [GitLab Starter][products]. It can be enabled -> in the project's settings. -> - Templates for issues were [introduced][ee-28] in GitLab EE 8.1. -> - Templates for merge requests were [introduced][ee-7478ece] in GitLab EE 6.9. +> - 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 issues were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28) in GitLab EE 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 with access" or "Only Project Members" in your project's **Settings / Visibility, project features, permissions** section, otherwise the template text areas won't show. This is the default behavior so in most cases you should be fine. -Go to your project's **Settings** and under the **Merge requests** header, click *Expand* and fill in the "Default description template -for merge requests" text area. Under the **Default issue template**, click *Expand* and fill in "Default description template for issues" text area. Since GitLab merge request and issues - support [Markdown](../markdown.md), you can use special markup like -headings, lists, etc. +1. Go to your project's **Settings**. +1. Click **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. ![Default merge request description templates](img/description_templates_merge_request_settings.png) + ![Default issue description templates](img/description_templates_issue_settings.png) After you add the description, hit **Save changes** for the settings to take @@ -84,12 +84,16 @@ pre-filled with the text you entered in the template(s). ## Description template example -We make use of Description Templates for Issues and Merge Requests within the GitLab Community Edition project. Please refer to the [`.gitlab` folder][gitlab-templates] for some examples. +We make use of Description Templates for Issues and Merge Requests within the GitLab Community +Edition project. Please refer to the [`.gitlab` folder](https://gitlab.com/gitlab-org/gitlab/tree/master/.gitlab) +for some examples. -> **Tip:** -It is possible to use [quick actions](quick_actions.md) within description templates to quickly add labels, assignees, and milestones. The quick actions will only be executed if the user submitting the Issue or Merge Request has the permissions to perform the relevant actions. +TIP: **Tip:** +It's possible to use [quick actions](quick_actions.md) within description templates to quickly add +labels, assignees, and milestones. The quick actions will only be executed if the user submitting +the issue or merge request has the permissions to perform the relevant actions. -Here is an example for a Bug report template: +Here is an example of a Bug report template: ```plaintext Summary @@ -133,9 +137,3 @@ Possible fixes /cc @project-manager /assign @qa-tester ``` - -[ce-4981]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/4981 -[gitlab-templates]: https://gitlab.com/gitlab-org/gitlab/tree/master/.gitlab -[ee-28]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28 "Merge Request for adding issues template" -[ee-7478ece]: https://gitlab.com/gitlab-org/gitlab/commit/7478ece8b48e80782b5465b96c79f85cc91d391b "Commit that introduced merge requests templates" -[products]: https://about.gitlab.com/pricing/ diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 464929a7e6c..1b9077299d7 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -1,12 +1,13 @@ # Issue Boards -> [Introduced][ce-5554] in [GitLab 8.11](https://about.gitlab.com/releases/2016/08/22/gitlab-8-11-released/#issue-board). +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5554) in [GitLab 8.11](https://about.gitlab.com/releases/2016/08/22/gitlab-8-11-released/#issue-board). ## Overview The GitLab Issue Board is a software project management tool used to plan, organize, and visualize a workflow for a feature or product release. -It can be used as a [Kanban] or a [Scrum] board. +It can be used as a [Kanban](https://en.wikipedia.org/wiki/Kanban_(development)) or a +[Scrum](https://en.wikipedia.org/wiki/Scrum_(software_development)) board. It provides perfect pairing between issue tracking and project management, keeping everything in the same place, so that you don't need to jump @@ -191,8 +192,10 @@ This allows you to create unique boards according to your team's need. ![Create scoped board](img/issue_board_creation.png) -You can define the scope of your board when creating it or by clicking on the "Edit board" button. Once a milestone, assignee or weight is assigned to an Issue Board, you will no longer be able to filter -through these in the search bar. In order to do that, you need to remove the desired scope (e.g. milestone, assignee or weight) from the Issue Board. +You can define the scope of your board when creating it or by clicking on the "Edit board" button. +Once a milestone, assignee or weight is assigned to an Issue Board, you will no longer be able to +filter through these in the search bar. In order to do that, you need to remove the desired scope +(for example, milestone, assignee, or weight) from the Issue Board. ![Edit board configuration](img/issue_board_edit_button.png) @@ -381,21 +384,21 @@ that order simply by dragging and dropping the issues. The changed order will be to the system so that anybody who visits the same board later will see the reordering, with some exceptions. -The first time a given issue appears in any board (i.e. the first time a user -loads a board containing that issue), it will be ordered with +The first time a given issue appears in any board (that is, the first time a user +loads a board containing that issue), it is ordered with respect to other issues in that list according to [Priority order](labels.md#label-priority). -At that point, that issue will be assigned a relative order value by the system +At that point, that issue is assigned a relative order value by the system representing its relative order with respect to the other issues in the list. Any time -you drag-and-drop reorder that issue, its relative order value will change accordingly. +you drag-and-drop reorder that issue, its relative order value changes accordingly. -Also, any time that issue appears in any board when it is loaded by a user, -the updated relative order value will be used for the ordering. (It's only the first +Also, any time that issue appears in any board when it's loaded by a user, +the updated relative order value is used for the ordering. (It's only the first time an issue appears that it takes from the Priority order mentioned above.) This means that if issue `A` is drag-and-drop reordered to be above issue `B` by any user in a given board inside your GitLab instance, any time those two issues are subsequently -loaded in any board in the same instance (could be a different project board or a different group board, for example), -that ordering will be maintained. +loaded in any board in the same instance (could be a different project board or a different group +board, for example), that ordering is maintained. This ordering also affects [issue lists](issues/sorting_issue_lists.md). Changing the order in an issue board changes the ordering in an issue list, @@ -413,7 +416,7 @@ You can filter by author, assignee, milestone, and label. By reordering your lists, you can create workflows. As lists in Issue Boards are based on labels, it works out of the box with your existing issues. So if you've -already labeled things with 'Backend' and 'Frontend', the issue will appear in +already labeled things with 'Backend' and 'Frontend', the issue appears in the lists as you create them. In addition, this means you can easily move something between lists by changing a label. @@ -464,7 +467,7 @@ You can select multiple issue cards, then drag the group to another position wit To select and move multiple cards: 1. Select each card with <kbd>Ctrl</kbd>+`Click` on Windows or Linux, or <kbd>Cmd</kbd>+`Click` on MacOS. -1. Drag one of the selected cards to another position or list and all selected cards will be moved. +1. Drag one of the selected cards to another position or list and all selected cards are moved. ![Multi-select Issue Cards](img/issue_boards_multi_select_v12_4.png) @@ -476,13 +479,9 @@ A few things to remember: and adds the label from the list it goes to. - An issue can exist in multiple lists if it has more than one label. - Lists are populated with issues automatically if the issues are labeled. -- Clicking on the issue title inside a card will take you to that issue. -- Clicking on a label inside a card will quickly filter the entire Issue Board +- Clicking on the issue title inside a card takes you to that issue. +- Clicking on a label inside a card quickly filters the entire Issue Board and show only the issues from all lists that have that label. - For performance and visibility reasons, each list shows the first 20 issues - by default. If you have more than 20 issues start scrolling down and the next - 20 will appear. - -[ce-5554]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5554 -[scrum]: https://en.wikipedia.org/wiki/Scrum_(software_development) -[kanban]: https://en.wikipedia.org/wiki/Kanban_(development) + by default. If you have more than 20 issues, start scrolling down and the next + 20 appears. |