diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-08 21:09:12 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-08 21:09:12 +0300 |
commit | 0179dc40d71c2549d787d2f5fa7ba6dc6efae376 (patch) | |
tree | 9709db4077ec0f3f471e9b8094b0de67a3ab947c /doc/user | |
parent | 770d6dbfa7111324f994f12664a2036c7121602a (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
15 files changed, 42 insertions, 41 deletions
diff --git a/doc/user/admin_area/settings/continuous_integration.md b/doc/user/admin_area/settings/continuous_integration.md index 0756086af73..af18ab685e6 100644 --- a/doc/user/admin_area/settings/continuous_integration.md +++ b/doc/user/admin_area/settings/continuous_integration.md @@ -27,7 +27,7 @@ From now on, every existing project and newly created ones that don't have a `.gitlab-ci.yml`, will use the Auto DevOps pipelines. If you want to disable it for a specific project, you can do so in -[its settings](../../../topics/autodevops/index.md#enablingdisabling-auto-devops). +[its settings](../../../topics/autodevops/index.md#enable-or-disable-auto-devops). ## Maximum artifacts size **(FREE SELF)** diff --git a/doc/user/application_security/vulnerability_report/img/vulnerability_details_create_issue_v13_7.png b/doc/user/application_security/vulnerability_report/img/vulnerability_details_create_issue_v13_7.png Binary files differdeleted file mode 100644 index 5184ad85fa9..00000000000 --- a/doc/user/application_security/vulnerability_report/img/vulnerability_details_create_issue_v13_7.png +++ /dev/null diff --git a/doc/user/clusters/agent/index.md b/doc/user/clusters/agent/index.md index 11f8c7cb6c6..4c6ef5cd601 100644 --- a/doc/user/clusters/agent/index.md +++ b/doc/user/clusters/agent/index.md @@ -55,13 +55,12 @@ There are several components that work in concert for the Agent to accomplish Gi Agent which repositories to synchronize with the cluster. - A manifest repository that contains manifest files. Any changes to manifest files are applied to the cluster. -These repositories might be the same GitLab project or separate projects. +You can use the same GitLab project or separate projects for configuration and manifest files, as follows: -NOTE: -GitLab recommends you use the same GitLab project for the agent configuration -and manifest repositories. Our backlog contains issues for adding support for +- Single GitLab project (recommended): when you use a single repository to hold both the manifest and the configuration files, these projects can be either private or public, as you prefer. +- Two GitLab projects: when you opt to use two different GitLab projects, one for manifest files, and another for configuration files, the manifests project must be private, while the configuration project can be either private or public. Our backlog contains issues for adding support for [private manifest repositories outside of the configuration project](https://gitlab.com/gitlab-org/gitlab/-/issues/220912) and -[group level agents](https://gitlab.com/gitlab-org/gitlab/-/issues/283885). +[group level agents](https://gitlab.com/gitlab-org/gitlab/-/issues/283885) in the future. For more details, please refer to our [full architecture documentation](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/master/doc/architecture.md#high-level-architecture) in the Agent project. diff --git a/doc/user/project/file_lock.md b/doc/user/project/file_lock.md index 5c24ec6caf6..4edb6fbdad9 100644 --- a/doc/user/project/file_lock.md +++ b/doc/user/project/file_lock.md @@ -36,9 +36,9 @@ GitLab supports two different modes of file locking: Locks can be created by any person who has at least [Developer permissions](../permissions.md) to the repository. -Only the user who locked the file or directory can edit locked files. Others -users will be prevented from modifying locked files by pushing, merging, -or any other means, and will be shown an error like: `The path '.gitignore' is +Only the user who locked the file or directory can edit locked files. Other +users are prevented from modifying locked files by pushing, merging, +or any other means, and are shown an error like: `The path '.gitignore' is locked by Administrator`. ## Exclusive file locks **(FREE)** @@ -60,7 +60,7 @@ Before getting started, make sure you have [Git LFS installed](../../topics/git/ git-lfs --version ``` -If it doesn't recognize this command, you'll have to install it. There are +If it doesn't recognize this command, you must install it. There are several [installation methods](https://git-lfs.github.com/) that you can choose according to your OS. To install it with Homebrew: @@ -70,7 +70,7 @@ brew install git-lfs Once installed, **open your local repository in a terminal window** and install Git LFS in your repository. If you're sure that LFS is already installed, -you can skip this step. If you're unsure, re-installing it won't do any harm: +you can skip this step. If you're unsure, re-installing it does no harm: ```shell git lfs install @@ -84,14 +84,14 @@ You need [Maintainer permissions](../permissions.md) to configure Exclusive File Locks for your project through the command line. The first thing to do before using File Locking is to tell Git LFS which -kind of files are lockable. The following command will store PNG files +kind of files are lockable. The following command stores PNG files in LFS and flag them as lockable: ```shell git lfs track "*.png" --lockable ``` -After executing the above command a file named `.gitattributes` will be +After executing the above command a file named `.gitattributes` is created or updated with the following content: ```shell @@ -110,9 +110,9 @@ implements the LFS File Locking API). To do that you can edit the The `.gitattributes` file is key to the process and **must** be pushed to the remote repository for the changes to take effect. -After a file type has been registered as lockable, Git LFS will make -them read-only on the file system automatically. This means you will -need to **lock the file** before [editing it](#edit-lockable-files). +After a file type has been registered as lockable, Git LFS makes +them read-only on the file system automatically. This means you +must **lock the file** before [editing it](#edit-lockable-files). ### Lock files @@ -168,7 +168,7 @@ git lfs locks The output lists the locked files followed by the user who locked each of them and the files' IDs. -On the repository file tree, GitLab will display an LFS badge for files +On the repository file tree, GitLab displays an LFS badge for files tracked by Git LFS plus a padlock icon on exclusively-locked files: ![LFS-Locked files](img/lfs_locked_files_v13_2.png) @@ -176,7 +176,7 @@ tracked by Git LFS plus a padlock icon on exclusively-locked files: You can also [view and remove existing locks](#view-and-remove-existing-locks) from the GitLab UI. NOTE: -When you rename an exclusively-locked file, the lock is lost. You'll have to +When you rename an exclusively-locked file, the lock is lost. You must lock it again to keep it locked. ### Edit lockable files @@ -204,7 +204,7 @@ or higher tiers. Default branch file and directory locks only apply to the default branch set in the project's settings (usually `master`). -Changes to locked files on the default branch will be blocked, including merge +Changes to locked files on the default branch are blocked, including merge requests that modify locked files. Unlock the file to allow changes. ### Lock a file or a directory @@ -216,10 +216,10 @@ To lock a file: ![Locking file](img/file_lock.png) -An **Unlock** button will be displayed if the file is already locked, and -will be disabled if you do not have permission to unlock the file. +An **Unlock** button is displayed if the file is already locked, and +is disabled if you do not have permission to unlock the file. -If you did not lock the file, hovering your cursor over the button will show +If you did not lock the file, hovering your cursor over the button shows who locked the file. ### View and remove existing locks diff --git a/doc/user/project/git_attributes.md b/doc/user/project/git_attributes.md index 2806f6e48d1..11d1db195e1 100644 --- a/doc/user/project/git_attributes.md +++ b/doc/user/project/git_attributes.md @@ -17,7 +17,7 @@ directory of your repository and push it to the default branch of your project. ## Encoding Requirements The `.gitattributes` file _must_ be encoded in UTF-8 and _must not_ contain a -Byte Order Mark. If a different encoding is used, the file's contents will be +Byte Order Mark. If a different encoding is used, the file's contents are ignored. ## Syntax Highlighting diff --git a/doc/user/project/img/autocomplete_characters_example1_v12_0.png b/doc/user/project/img/autocomplete_characters_example1_v12_0.png Binary files differdeleted file mode 100644 index 9c6fa923b80..00000000000 --- a/doc/user/project/img/autocomplete_characters_example1_v12_0.png +++ /dev/null diff --git a/doc/user/project/img/autocomplete_characters_example2_v12_0.png b/doc/user/project/img/autocomplete_characters_example2_v12_0.png Binary files differdeleted file mode 100644 index b2e8a782a0b..00000000000 --- a/doc/user/project/img/autocomplete_characters_example2_v12_0.png +++ /dev/null diff --git a/doc/user/project/integrations/img/mattermost_config_help.png b/doc/user/project/integrations/img/mattermost_config_help.png Binary files differdeleted file mode 100644 index dd3481bc1f6..00000000000 --- a/doc/user/project/integrations/img/mattermost_config_help.png +++ /dev/null diff --git a/doc/user/project/integrations/img/mattermost_slash_command_configuration.png b/doc/user/project/integrations/img/mattermost_slash_command_configuration.png Binary files differdeleted file mode 100644 index f9e9de439ca..00000000000 --- a/doc/user/project/integrations/img/mattermost_slash_command_configuration.png +++ /dev/null diff --git a/doc/user/project/members/img/project_members_filter_v12_6.png b/doc/user/project/members/img/project_members_filter_v12_6.png Binary files differdeleted file mode 100644 index 692fdfe00a1..00000000000 --- a/doc/user/project/members/img/project_members_filter_v12_6.png +++ /dev/null diff --git a/doc/user/project/merge_requests/fast_forward_merge.md b/doc/user/project/merge_requests/fast_forward_merge.md index c4a34f9c65c..b1e8d761f5c 100644 --- a/doc/user/project/merge_requests/fast_forward_merge.md +++ b/doc/user/project/merge_requests/fast_forward_merge.md @@ -17,7 +17,7 @@ to accept merge requests without creating merge commits. When the fast-forward merge ([`--ff-only`](https://git-scm.com/docs/git-merge#git-merge---ff-only)) setting -is enabled, no merge commits will be created and all merges are fast-forwarded, +is enabled, no merge commits are created and all merges are fast-forwarded, which means that merging is only allowed if the branch can be fast-forwarded. When a fast-forward merge is not possible, the user is given the option to rebase. @@ -28,19 +28,19 @@ When a fast-forward merge is not possible, the user is given the option to rebas 1. Select the **Fast-forward merge** option 1. Hit **Save changes** for the changes to take effect -Now, when you visit the merge request page, you will be able to accept it +Now, when you visit the merge request page, you can accept it **only if a fast-forward merge is possible**. ![Fast forward merge request](img/ff_merge_mr.png) If a fast-forward merge is not possible but a conflict free rebase is possible, -a rebase button will be offered. +a rebase button is offered. ![Fast forward merge request](img/ff_merge_rebase.png) If the target branch is ahead of the source branch and a conflict free rebase is not possible, you need to rebase the -source branch locally before you will be able to do a fast-forward merge. +source branch locally before you can do a fast-forward merge. ![Fast forward merge rebase locally](img/ff_merge_rebase_locally.png) diff --git a/doc/user/project/merge_requests/img/multiline-comment-highlighted.png b/doc/user/project/merge_requests/img/multiline-comment-highlighted.png Binary files differdeleted file mode 100644 index 1bdcc37e274..00000000000 --- a/doc/user/project/merge_requests/img/multiline-comment-highlighted.png +++ /dev/null diff --git a/doc/user/project/merge_requests/merge_request_approvals.md b/doc/user/project/merge_requests/merge_request_approvals.md index eab84aed077..05e9ea786ab 100644 --- a/doc/user/project/merge_requests/merge_request_approvals.md +++ b/doc/user/project/merge_requests/merge_request_approvals.md @@ -79,7 +79,7 @@ An individual user can be added as an approver for a project if they are a membe - The project's immediate parent group. - A group that has access to the project via a [share](../members/share_project_with_groups.md). -A group of users can also be added as approvers, though they will only count as approvers if +A group of users can also be added as approvers, though they only count as approvers if they have direct membership to the group. In the future, group approvers may be [restricted to only groups with share access to the project](https://gitlab.com/gitlab-org/gitlab/-/issues/2048). diff --git a/doc/user/project/merge_requests/squash_and_merge.md b/doc/user/project/merge_requests/squash_and_merge.md index 1b99b1b5c44..f500c18a32e 100644 --- a/doc/user/project/merge_requests/squash_and_merge.md +++ b/doc/user/project/merge_requests/squash_and_merge.md @@ -31,7 +31,7 @@ NOTE: The squashed commit in this example is followed by a merge commit, because the merge method for this repository uses a merge commit. You can disable merge commits in **Project Settings > General > Merge requests > Merge method > Fast-forward merge**. -The squashed commit's commit message will be either: +The squashed commit's commit message is either: - Taken from the first multi-line commit message in the merge. - The merge request's title if no multi-line commit message is found. @@ -60,7 +60,7 @@ This way, the history of your base branch remains clean with meaningful commit messages and: - It's simpler to [revert](revert_changes.md) if necessary. -- The merged branch will retain the full commit history. +- The merged branch retains the full commit history. ## Enabling squash for a merge request @@ -113,18 +113,18 @@ squashing can itself be considered equivalent to rebasing. With Squash Commits Options you can configure the behavior of Squash and Merge for your project. To set it up, navigate to your project's **Settings > General** and expand **Merge requests**. -You will find the following options to choose, which will affect existing and new merge requests +You can choose from these options, which affect existing and new merge requests submitted to your project: - **Do not allow**: users cannot use Squash and Merge to squash all the commits immediately before - merging. The checkbox to enable or disable it will be unchecked and hidden from the users. -- **Allow**: users will have the option to enable Squash and Merge on a merge request basis. - The checkbox will be unchecked (disabled) by default, but and the user is allowed to enable it. -- **Encourage**: users will have the option to enable Squash and Merge on a merge request basis. - The checkbox will be checked (enabled) by default to encourage its use, but the user is allowed to + merging. The checkbox to enable or disable it is unchecked and hidden from the users. +- **Allow**: users can enable Squash and Merge on a merge request basis. + The checkbox is unchecked (disabled) by default, but and the user is allowed to enable it. +- **Encourage**: users can enable Squash and Merge on a merge request basis. + The checkbox is checked (enabled) by default to encourage its use, but the user is allowed to disable it. -- **Require**: Squash and Merge is enabled for all merge requests, so it will always be performed. - The checkbox to enable or disable it will be checked and hidden from the users. +- **Require**: Squash and Merge is enabled for all merge requests, so it is always performed. + The checkbox to enable or disable it is checked and hidden from the users. The Squash and Merge checkbox is displayed when you create a merge request and when you edit the description of an existing one, except when Squash Commit Options is set to **Do not allow** or **Require**. diff --git a/doc/user/project/requirements/index.md b/doc/user/project/requirements/index.md index e6b89098319..bd37acafd22 100644 --- a/doc/user/project/requirements/index.md +++ b/doc/user/project/requirements/index.md @@ -96,18 +96,20 @@ As soon as a requirement is reopened, it no longer appears in the **Archived** t ## Search for a requirement -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212543) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212543) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1. +> - Searching by status [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/224614) in GitLab 13.10. You can search for a requirement from the requirements list page based on the following criteria: -- Requirement title +- Title - Author's username +- Status (satisfied, failed, or missing) To search for a requirement: 1. In a project, go to **Requirements > List**. 1. Select the **Search or filter results** field. A dropdown menu appears. -1. Select the requirement author from the dropdown or enter plain text to search by requirement title. +1. Select the requirement author or status from the dropdown or enter plain text to search by requirement title. 1. Press <kbd>Enter</kbd> on your keyboard to filter the list. You can also sort the requirements list by: |