Merge branch 'docs-new-merge-request' into 'master'

Docs: revamp docs for creating MRs

Closes #39523

See merge request gitlab-org/gitlab!21956

doc/administration/incoming_email.md

@@ -7,7 +7,7 @@ GitLab has several features based on receiving incoming emails:
 - [New issue by email](../user/project/issues/managing_issues.md#new-issue-via-email):
   allow GitLab users to create a new issue by sending an email to a
   user-specific email address.
-- [New merge request by email](../user/project/merge_requests/creating_merge_requests.md#create-new-merge-requests-by-email):
+- [New merge request by email](../user/project/merge_requests/creating_merge_requests.md#new-merge-request-by-email-core-only):
   allow GitLab users to create a new merge request by sending an email to a
   user-specific email address.
 - [Service Desk](../user/project/service_desk.md): provide e-mail support to
@@ -79,7 +79,7 @@ email address in order to sign up.
 If you also host a public-facing GitLab instance at `hooli.com` and set your
 incoming email domain to `hooli.com`, an attacker could abuse the "Create new
 issue by email" or
-"[Create new merge request by email](../user/project/merge_requests/creating_merge_requests.md#create-new-merge-requests-by-email)"
+"[Create new merge request by email](../user/project/merge_requests/creating_merge_requests.md#new-merge-request-by-email-core-only)"
 features by using a project's unique address as the email when signing up for
 Slack, which would send a confirmation email, which would create a new issue or
 merge request on the project owned by the attacker, allowing them to click the

doc/administration/index.md

@@ -119,7 +119,7 @@ Learn how to install, configure, update, and maintain your GitLab instance.
 - [Auditor users](auditor_users.md): Users with read-only access to all projects, groups, and other resources on the GitLab instance. **(PREMIUM ONLY)**
 - [Incoming email](incoming_email.md): Configure incoming emails to allow
   users to [reply by email](reply_by_email.md), create [issues by email](../user/project/issues/managing_issues.md#new-issue-via-email) and
-  [merge requests by email](../user/project/merge_requests/creating_merge_requests.md#create-new-merge-requests-by-email), and to enable [Service Desk](../user/project/service_desk.md).
+  [merge requests by email](../user/project/merge_requests/creating_merge_requests.md#new-merge-request-by-email-core-only), and to enable [Service Desk](../user/project/service_desk.md).
   - [Postfix for incoming email](reply_by_email_postfix_setup.md): Set up a
   basic Postfix mail server with IMAP authentication on Ubuntu for incoming
   emails.

doc/development/documentation/workflow.md

@@ -297,8 +297,7 @@ To request help:
 1. Locate the the Technical Writer for the relevant
    [DevOps stage group](https://about.gitlab.com/handbook/product/technical-writing/index.html#assignments).
 1. Either:
-   - If urgent help is required, directly assign the Technical Writer in the issue or
-     [in the merge request](../../user/project/merge_requests/creating_merge_requests.md#multiple-assignees-starter).
+   - If urgent help is required, directly assign the Technical Writer in the issue or in the merge request.
    - If non-urgent help is required, ping the Technical Writer in the issue or merge request.
 
 If you are a member of GitLab's Slack workspace, you can request help in `#docs`.

doc/gitlab-basics/add-merge-request.md

 ---
-type: howto
+redirect_to: '../user/project/merge_requests/creating_merge_requests.md'
 ---
 
-# How to create a merge request
-
-Merge requests are how you integrate separate changes that you've made in a
-[branch](create-branch.md) to a [project](create-project.md).
-
-This is a brief guide on how to create a merge request. For more detailed information,
-check the [merge requests documentation](../user/project/merge_requests/index.md), or
-you can watch our [GitLab Flow video](https://www.youtube.com/watch?v=InKNIvky2KE) for
-a quick overview of working with merge requests.
-
-1. Before you start, you should have already [created a branch](create-branch.md)
-   and [pushed your changes](start-using-git.md#send-changes-to-gitlabcom) to GitLab.
-1. Go to the project where you'd like to merge your changes and click on the
-   **Merge requests** tab.
-1. Click on **New merge request** on the right side of the screen.
-1. From there, you have the option to select the source branch and the target
-   branch you'd like to compare to. The default target project is the upstream
-   repository, but you can choose to compare across any of its forks.
-
-   ![Select a branch](img/merge_request_select_branch.png)
-
-1. When ready, click on the **Compare branches and continue** button.
-1. At a minimum, add a title and a description to your merge request. Optionally,
-   select a user to review your merge request. You may also select a milestone and
-   labels.
-
-   ![New merge request page](img/merge_request_page.png)
-
-1. When ready, click on the **Submit merge request** button.
-
-Your merge request will be ready to be reviewed, approved, and merged.
-
-<!-- ## Troubleshooting
-
-Include any troubleshooting steps that you can foresee. If you know beforehand what issues
-one might have when setting this up, or when something is changed, or on upgrading, it's
-important to describe those, too. Think of things that may go wrong and include them here.
-This is important to minimize requests for support, and to avoid doc comments with
-questions that you know someone might ask.
-
-Each scenario can be a third-level heading, e.g. `### Getting error message X`.
-If you have none to add when creating a doc, leave this section in place
-but commented out to help encourage others to add to it in the future. -->
+This document was moved to [another location](../user/project/merge_requests/creating_merge_requests.md).

doc/user/project/merge_requests/getting_started.md

+---
+type: index, reference
+description: "Getting started with Merge Requests."
+---
+
+# Getting started with Merge Requests
+
+A Merge Request (**MR**) is the basis of GitLab as a code
+collaboration and version control.
+
+When working in a Git-based platform, you can use branching
+strategies to collaborate on code.
+
+A repository is composed by its _default branch_, which contains
+the major version of the codebase, from which you create minor
+branches, also called _feature branches_, to propose changes to
+the codebase without introducing them directly into the major
+version of the codebase.
+
+Branching is specially important when collaborating with others,
+avoiding changes to be pushed directly to the default branch
+without prior reviews, tests, and approvals.
+
+When you create a new feature branch, change the files, and push
+it to GitLab, you have the option to create a **Merge Request**,
+which is essentially a _request_ to merge one branch into another.
+
+The branch you added your changes into is called _source branch_
+while the branch you'll request to merge your changes into is
+called _target branch_.
+
+The target branch can be the default or any other branch, depending
+on the branching strategies you choose.
+
+In a merge request, beyond visualizing the differences between the
+original content and your proposed changes, you can execute a
+[significant number of tasks](#what-you-can-do-with-merge-requests)
+before concluding your work and merging the merge request.
+
+You can watch our [GitLab Flow video](https://www.youtube.com/watch?v=InKNIvky2KE) for
+a quick overview of working with merge requests.
+
+## How to create a merge request
+
+Learn the various ways to [create a merge request](creating_merge_requests.md).
+
+## What you can do with merge requests
+
+When you start a new merge request, you'll have the following
+options to include straightaway (you can also add them later by
+clicking the **Edit** button on the merge request's page at the
+top-right side):
+
+- [Assign](#assignee) the merge request to a colleage for review.With GitLab Starter and higher tiers, you can [assign it to more than one person at a time](#multiple-assignees-starter).
+- Set a [milestone](../milestones/index.md) to track time-sensitive changes.
+- Add [labels](../labels.md) to help contextualize and filter your merge requests over time.
+- Require [approval](merge_request_approvals.md) from your team. **(STARTER)**
+- [Close issues automatically](#merge-requests-to-close-issues) when it's merged.
+- Enable the [delete source branch when merge request is accepted](#deleting-the-source-branch) option to keep your repository clean.
+- Enable the [squash commits when merge request is accepted](squash_and_merge.md) option to combine all the commits into one before merging, thus keep a clean commit history in your repository.
+- Set the merge request as a [Work In Progress (WIP)](work_in_progress_merge_requests.md) to avoid accidental merges before it's ready.
+
+Once you have created the merge request, you can also:
+
+- [Discuss](../../discussions/index.md) your implementation with your team in the merge request thread.
+- [Perform inline code reviews](reviewing_and_managing_merge_requests.md#perform-inline-code-reviews).
+- Add [merge request dependencies](merge_request_dependencies.md) to restrict it to be merged only when other merge requests have been merged. **(PREMIUM)**
+- Preview continuous integration [pipelines on the merge request widget](reviewing_and_managing_merge_requests.md#pipeline-status-in-merge-requests-widgets).
+- Preview how your changes look directly on your deployed application with [Review Apps](reviewing_and_managing_merge_requests.md#live-preview-with-review-apps).
+- [Allow collaboration on merge requests across forks](allow_collaboration.md).
+- Perform a [Review](../../discussions/index.md#merge-request-reviews-premium) in order to create multiple comments on a diff and publish them once you're ready. **(PREMIUM)**
+- Add [code suggestions](../../discussions/index.md#suggest-changes) to change the content of merge requests directly into merge request threads, and easily apply them to the codebase directly from the UI.
+- Add a time estimation and the time spent with that merge request with [Time Tracking](../time_tracking.md#time-tracking).
+
+Many of these can be set when pushing changes from the command line,
+with [Git push options](../push_options.md).
+
+See also other [features associated to merge requests](reviewing_and_managing_merge_requests.md#associated-features).
+
+### Assignee
+
+Choose an assignee to designate someone as the person responsible
+for the first [review of the merge request](reviewing_and_managing_merge_requests.md).
+Open the drop down box to search for the user you wish to assign,
+and the merge request will be added to their
+[assigned merge request list](../../search/index.md#issues-and-merge-requests).
+
+#### Multiple assignees **(STARTER)**
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/2004) in [GitLab Starter 11.11](https://about.gitlab.com/pricing/).
+
+Multiple people often review merge requests at the same time.
+GitLab allows you to have multiple assignees for merge requests
+to indicate everyone that is reviewing or accountable for it.
+
+![multiple assignees for merge requests sidebar](img/multiple_assignees_for_merge_requests_sidebar.png)
+
+To assign multiple assignees to a merge request:
+
+1. From a merge request, expand the right sidebar and locate the **Assignees** section.
+1. Click on **Edit** and from the dropdown menu, select as many users as you want to assign the merge request to.
+
+Similarly, assignees are removed by deselecting them from the same
+dropdown menu.
+
+It's also possible to manage multiple assignees:
+
+- When creating a merge request.
+- Using [quick actions](../quick_actions.md#quick-actions-for-issues-merge-requests-and-epics).
+
+### Merge requests to close issues
+
+If the merge request is being created to resolve an issue, you can
+add a note in the description which will set it to
+[automatically close the issue](../issues/managing_issues.md#closing-issues-automatically)
+when merged.
+
+If the issue is [confidential](../issues/confidential_issues.md),
+you may want to use a different workflow for
+[merge requests for confidential issues](../issues/confidential_issues.md#merge-requests-for-confidential-issues)
+to prevent confidential information from being exposed.
+
+### Deleting the source branch
+
+When creating a merge request, select the "Delete source branch
+when merge request accepted" option and the source branch will be
+deleted when the merge request is merged. To make this option
+enabled by default for all new merge requests, enable it in the
+[project's settings](../settings/index.md#merge-request-settings).
+
+This option is also visible in an existing merge request next to
+the merge request button and can be selected/deselected before merging.
+It's only visible to users with [Maintainer permissions](../../permissions.md)
+in the source project.
+
+If the user viewing the merge request does not have the correct
+permissions to delete the source branch and the source branch
+is set for deletion, the merge request widget will show the
+**Deletes source branch** text.
+
+![Delete source branch status](img/remove_source_branch_status.png)
+
+## Recommendations and best practices for Merge Requests
+
+- When working locally in your branch, add multiple commits and only push when you're done, so GitLab will run only one pipeline for all the commits pushed at once. By doing so, you save pipeline minutes.
+- Delete feature branches on merge or after merging them to keep your repository clean.
+- Take one thing at a time and ship the smallest changes possible. By doing so, you'll have faster reviews and your changes will be less prone to errors.
+- Don't use capital letters nor special chars in branch names.

doc/user/project/merge_requests/reviewing_and_managing_merge_requests.md

@@ -85,7 +85,7 @@ specific commit page.
 You can append `?w=1` while on the diffs page of a merge request to ignore any
 whitespace changes.
 
-## Commenting on any file line in merge requests
+## Perform inline code reviews
 
 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/13950) in GitLab 11.5.
 
@@ -94,20 +94,7 @@ in a Merge Request. To do so, click the **...** button in the gutter of the Merg
 
 ![Comment on any diff file line](img/comment-on-any-diff-line.png)
 
-## Live preview with Review Apps
-
-If you configured [Review Apps](https://about.gitlab.com/product/review-apps/) for your project,
-you can preview the changes submitted to a feature-branch through a merge request
-in a per-branch basis. No need to checkout the branch, install and preview locally;
-all your changes will be available to preview by anyone with the Review Apps link.
-
-With GitLab's [Route Maps](../../../ci/review_apps/index.md#route-maps) set, the
-merge request widget takes you directly to the pages changed, making it easier and
-faster to preview proposed modifications.
-
-[Read more about Review Apps](../../../ci/review_apps/index.md).
-
-## Pipeline status in merge requests
+## Pipeline status in merge requests widgets
 
 If you've set up [GitLab CI/CD](../../../ci/README.md) in your project,
 you will be able to see:
@@ -135,6 +122,37 @@ be disabled. If the pipeline fails to deploy, the deployment info will be hidden
 
 For more information, [read about pipelines](../../../ci/pipelines.md).
 
+### Merge when pipeline succeeds (MWPS)
+
+Set a merge request that looks ready to merge to [merge automatically when CI pipeline succeeds](merge_when_pipeline_succeeds.md).
+
+### Live preview with Review Apps
+
+If you configured [Review Apps](https://about.gitlab.com/product/review-apps/) for your project,
+you can preview the changes submitted to a feature-branch through a merge request
+in a per-branch basis. No need to checkout the branch, install and preview locally;
+all your changes will be available to preview by anyone with the Review Apps link.
+
+With GitLab's [Route Maps](../../../ci/review_apps/index.md#route-maps) set, the
+merge request widget takes you directly to the pages changed, making it easier and
+faster to preview proposed modifications.
+
+[Read more about Review Apps](../../../ci/review_apps/index.md).
+
+## Associated features
+
+There is also a large number of features to associated to merge requests:
+
+| Feature                                                                                                                                               | Description                                                                                                                                              |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Bulk editing merge requests](../../project/bulk_editing.md)                                                                                          | Update the attributes of multiple merge requests simultaneously.                                                                                         |
+| [Cherry-pick changes](cherry_pick_changes.md)                                                                                                         | Cherry-pick any commit in the UI by simply clicking the **Cherry-pick** button in a merged merge requests or a commit.                                   |
+| [Fast-forward merge requests](fast_forward_merge.md)                                                                                                  | For a linear Git history and a way to accept merge requests without creating merge commits                                                               |
+| [Find the merge request that introduced a change](versions.md)                                                                                        | When viewing the commit details page, GitLab will link to the merge request(s) containing that commit.                                                   |
+| [Merge requests versions](versions.md)                                                                                                                | Select and compare the different versions of merge request diffs                                                                                         |
+| [Resolve conflicts](resolve_conflicts.md)                                                                                                             | GitLab can provide the option to resolve certain merge request conflicts in the GitLab UI.                                                               |
+| [Revert changes](revert_changes.md)                                                                                                                   | Revert changes from any commit from within a merge request.                                                                                              |
+
 ## Troubleshooting
 
 Sometimes things don't go as expected in a merge request, here are some

doc/user/project/settings/index.md

@@ -57,7 +57,7 @@ Set up your project's merge request settings:
 - Enable [merge request approvals](../merge_requests/merge_request_approvals.md). **(STARTER)**
 - Enable [merge only if pipeline succeeds](../merge_requests/merge_when_pipeline_succeeds.md).
 - Enable [merge only when all threads are resolved](../../discussions/index.md#only-allow-merge-requests-to-be-merged-if-all-threads-are-resolved).
-- Enable [`delete source branch after merge` option by default](../merge_requests/creating_merge_requests.md#deleting-the-source-branch)
+- Enable [`delete source branch after merge` option by default](../merge_requests/getting_started.md#deleting-the-source-branch)
 
 ![project's merge request settings](img/merge_requests_settings.png)