Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-05-10 21:10:41 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-05-10 21:10:41 +0300
commit7f04cb580bc7895145fc1df51907582f80adbbca (patch)
tree31eb03182fcd84002895e3befb3d453bbcf048b4 /doc/user
parentbd5eb9f0201cf39ecfb0e754787a2297d5fdf051 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/application_security/policies/index.md26
-rw-r--r--doc/user/markdown.md2
-rw-r--r--doc/user/project/deploy_keys/index.md2
-rw-r--r--doc/user/project/img/protected_branches_list_v12_3.pngbin10208 -> 0 bytes
-rw-r--r--doc/user/project/img/protected_branches_page_v12_3.pngbin16336 -> 0 bytes
-rw-r--r--doc/user/project/import/bitbucket_server.md6
-rw-r--r--doc/user/project/import/gitea.md10
-rw-r--r--doc/user/project/import/jira.md2
-rw-r--r--doc/user/project/import/manifest.md12
-rw-r--r--doc/user/project/import/svn.md2
-rw-r--r--doc/user/project/import/tfvc.md14
-rw-r--r--doc/user/project/members/img/add_user_give_permissions_v13_8.pngbin69132 -> 0 bytes
-rw-r--r--doc/user/project/members/img/add_user_import_members_from_another_project_v13_8.pngbin35191 -> 0 bytes
-rw-r--r--doc/user/project/members/img/add_user_imported_members_v13_9.pngbin58569 -> 0 bytes
-rw-r--r--doc/user/project/members/img/add_user_list_members_v13_9.pngbin48350 -> 0 bytes
-rw-r--r--doc/user/project/members/img/add_user_search_people_v13_8.pngbin28335 -> 0 bytes
-rw-r--r--doc/user/project/members/index.md123
-rw-r--r--doc/user/project/members/share_project_with_groups.md2
-rw-r--r--doc/user/project/protected_branches.md53
19 files changed, 134 insertions, 120 deletions
diff --git a/doc/user/application_security/policies/index.md b/doc/user/application_security/policies/index.md
index c910ae6b662..92f0d6924b3 100644
--- a/doc/user/application_security/policies/index.md
+++ b/doc/user/application_security/policies/index.md
@@ -112,6 +112,16 @@ This rule enforces the defined actions whenever the pipeline runs for a selected
| `type` | `string` | `pipeline` | The rule's type. |
| `branches` | `array` of `string` | `*` or the branch's name | The branch the given policy applies to (supports wildcard). |
+### `schedule` rule type
+
+This rule enforces the defined actions and schedules a scan on the provided date/time.
+
+| Field | Type | Possible values | Description |
+|------------|------|-----------------|-------------|
+| `type` | `string` | `schedule` | The rule's type. |
+| `branches` | `array` of `string` | `*` or the branch's name | The branch the given policy applies to (supports wildcard). |
+| `cadence` | `string` | CRON expression (for example, `0 0 * * *`) | A whitespace-separated string containing five fields that represents the scheduled time. |
+
### `scan` action type
This action executes the selected `scan` with additional parameters when conditions for at least one
@@ -131,6 +141,9 @@ Note the following:
- Once you associate the site profile and scanner profile by name in the policy, it is not possible
to modify or delete them. If you want to modify them, you must first disable the policy by setting
the `active` flag to `false`.
+- When configuring policies with a scheduled DAST scan, the author of the commit in the security
+ policy project's repository must have access to the scanner and site profiles. Otherwise, the scan
+ is not scheduled successfully.
Here's an example:
@@ -148,13 +161,14 @@ scan_execution_policy:
- scan: dast
scanner_profile: Scanner Profile A
site_profile: Site Profile B
-- name: Enforce DAST in every pipeline in main branch
- description: This policy enforces pipeline configuration to have a job with DAST scan for main branch
+- name: Enforce DAST scan every 10 minutes
+ description: This policy enforces a DAST scan to run every 10 minutes
enabled: true
rules:
- - type: pipeline
+ - type: schedule
branches:
- main
+ cadence: */10 * * * *
actions:
- scan: dast
scanner_profile: Scanner Profile C
@@ -164,11 +178,7 @@ scan_execution_policy:
In this example, the DAST scan runs with the scanner profile `Scanner Profile A` and the site
profile `Site Profile B` for every pipeline executed on branches that match the
`release/*` wildcard (for example, branch name `release/v1.2.1`); and the DAST scan runs with
-the scanner profile `Scanner Profile C` and the site profile `Site Profile D` for every pipeline executed on `main` branch.
-
-NOTE:
-All scanner and site profiles must be configured and created for each project that is assigned to the selected Security Policy Project.
-If they are not created, the job will fail with the error message.
+the scanner profile `Scanner Profile C` and the site profile `Site Profile D` every 10 minutes.
## Security Policy project selection
diff --git a/doc/user/markdown.md b/doc/user/markdown.md
index 0c257f2fb70..cbd5bf1553a 100644
--- a/doc/user/markdown.md
+++ b/doc/user/markdown.md
@@ -1092,7 +1092,7 @@ Markdown is fine in GitLab.
</dd>
</dl>
-#### Details and summary
+#### Collapsible section
To see the second Markdown example rendered in HTML,
[view it in GitLab](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/user/markdown.md#details-and-summary).
diff --git a/doc/user/project/deploy_keys/index.md b/doc/user/project/deploy_keys/index.md
index bf082cca93a..45c42c78ab7 100644
--- a/doc/user/project/deploy_keys/index.md
+++ b/doc/user/project/deploy_keys/index.md
@@ -176,7 +176,7 @@ If the key is **privately accessible** and in use by other projects, it will be
If the owner of this deploy key doesn't have access to a [protected
branch](../protected_branches.md), then this deploy key doesn't have access to
the branch either. In addition to this, choosing the **No one** value in
-[the "Allowed to push" section](../protected_branches.md#configuring-protected-branches)
+[the "Allowed to push" section](../protected_branches.md#configure-a-protected-branch)
means that no users **and** no services using deploy keys can push to that selected branch.
Refer to [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/30769) for more information.
diff --git a/doc/user/project/img/protected_branches_list_v12_3.png b/doc/user/project/img/protected_branches_list_v12_3.png
deleted file mode 100644
index 995a294b85c..00000000000
--- a/doc/user/project/img/protected_branches_list_v12_3.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/img/protected_branches_page_v12_3.png b/doc/user/project/img/protected_branches_page_v12_3.png
deleted file mode 100644
index 60aa3c4d251..00000000000
--- a/doc/user/project/img/protected_branches_page_v12_3.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/import/bitbucket_server.md b/doc/user/project/import/bitbucket_server.md
index 330ed0cb774..1e79107d76f 100644
--- a/doc/user/project/import/bitbucket_server.md
+++ b/doc/user/project/import/bitbucket_server.md
@@ -22,10 +22,8 @@ The Bitbucket importer can import:
- Pull requests (GitLab 11.2+)
- Pull request comments (GitLab 11.2+)
-When importing:
-
-- Repository public access is retained. If a repository is private in Bitbucket, it's created as
- private in GitLab as well.
+When importing, repository public access is retained. If a repository is private in Bitbucket, it's
+created as private in GitLab as well.
## Limitations
diff --git a/doc/user/project/import/gitea.md b/doc/user/project/import/gitea.md
index 255d083be6f..41141902468 100644
--- a/doc/user/project/import/gitea.md
+++ b/doc/user/project/import/gitea.md
@@ -21,10 +21,8 @@ The Gitea importer can import:
- Milestones (GitLab 8.15+)
- Labels (GitLab 8.15+)
-When importing:
-
-- Repository public access is retained. If a repository is private in Gitea it's created as private
- in GitLab as well.
+When importing, repository public access is retained. If a repository is private in Gitea, it's
+created as private in GitLab as well.
## How it works
@@ -78,9 +76,9 @@ From there, you can see the import statuses of your Gitea repositories.
You also can:
- Import all your Gitea projects in one go by hitting **Import all projects** in
- the upper left corner
+ the upper left corner.
- Filter projects by name. If filter is applied, hitting **Import all projects**
- only imports matched projects
+ only imports matched projects.
![Gitea importer page](img/import_projects_from_gitea_importer_v12_3.png)
diff --git a/doc/user/project/import/jira.md b/doc/user/project/import/jira.md
index 6b8c34fada6..4273f90c1e7 100644
--- a/doc/user/project/import/jira.md
+++ b/doc/user/project/import/jira.md
@@ -59,7 +59,7 @@ Importing Jira issues is done as an asynchronous background job, which
may result in delays based on import queues load, system load, or other factors.
Importing large projects may take several minutes depending on the size of the import.
-To import Jira issues to a GitLab project, follow these steps:
+To import Jira issues to a GitLab project:
1. On the **{issues}** **Issues** page, click **Import Issues** (**{import}**) **> Import from Jira**.
diff --git a/doc/user/project/import/manifest.md b/doc/user/project/import/manifest.md
index 0c383a8baec..94eba319a17 100644
--- a/doc/user/project/import/manifest.md
+++ b/doc/user/project/import/manifest.md
@@ -51,13 +51,13 @@ As a result, the following projects are created:
## Import the repositories
-Follow these steps to start the import:
+To start the import:
-1. From your GitLab dashboard click **New project**
-1. Switch to the **Import project** tab
-1. Click on the **Manifest file** button
-1. Provide GitLab with a manifest XML file
-1. Select a group you want to import to (you need to create a group first if you don't have one)
+1. From your GitLab dashboard click **New project**.
+1. Switch to the **Import project** tab.
+1. Click on the **Manifest file** button.
+1. Provide GitLab with a manifest XML file.
+1. Select a group you want to import to (you need to create a group first if you don't have one).
1. Click **List available repositories**. At this point, you are redirected
to the import status page with projects list based on the manifest file.
1. Check the list and click **Import all repositories** to start the import.
diff --git a/doc/user/project/import/svn.md b/doc/user/project/import/svn.md
index 2a58a52ce2c..e39976e00f6 100644
--- a/doc/user/project/import/svn.md
+++ b/doc/user/project/import/svn.md
@@ -16,7 +16,7 @@ There are two approaches to SVN to Git migration:
- [Git/SVN Mirror](#smooth-migration-with-a-gitsvn-mirror-using-subgit) which:
- Makes the GitLab repository to mirror the SVN project.
- Git and SVN repositories are kept in sync; you can use either one.
- - Smoothens the migration process and allows to manage migration risks.
+ - Smoothens the migration process and allows you to manage migration risks.
- [Cut over migration](#cut-over-migration-with-svn2git) which:
- Translates and imports the existing data and history from SVN to Git.
diff --git a/doc/user/project/import/tfvc.md b/doc/user/project/import/tfvc.md
index ef44989d7f2..705df686fe0 100644
--- a/doc/user/project/import/tfvc.md
+++ b/doc/user/project/import/tfvc.md
@@ -46,12 +46,8 @@ Advantages of migrating to Git/GitLab:
Migration options from TFVC to Git depend on your operating system.
-- If you're migrating on Microsoft Windows:
-
- - Use the [`git-tfs`](https://github.com/git-tfs/git-tfs)
- tool. See [Migrate TFS to Git](https://github.com/git-tfs/git-tfs/blob/master/doc/usecases/migrate_tfs_to_git.md)
- for details.
-
-- If you're on a Unix-based system:
-
- - Follow the procedures described with this [TFVC to Git migration tool](https://github.com/turbo/gtfotfs).
+- If you're migrating on Microsoft Windows, use the [`git-tfs`](https://github.com/git-tfs/git-tfs)
+ tool. See [Migrate TFS to Git](https://github.com/git-tfs/git-tfs/blob/master/doc/usecases/migrate_tfs_to_git.md)
+ for details.
+- If you're on a Unix-based system, follow the procedures described with this
+ [TFVC to Git migration tool](https://github.com/turbo/gtfotfs).
diff --git a/doc/user/project/members/img/add_user_give_permissions_v13_8.png b/doc/user/project/members/img/add_user_give_permissions_v13_8.png
deleted file mode 100644
index 1916d056a52..00000000000
--- a/doc/user/project/members/img/add_user_give_permissions_v13_8.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/members/img/add_user_import_members_from_another_project_v13_8.png b/doc/user/project/members/img/add_user_import_members_from_another_project_v13_8.png
deleted file mode 100644
index a6dddec3fb7..00000000000
--- a/doc/user/project/members/img/add_user_import_members_from_another_project_v13_8.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/members/img/add_user_imported_members_v13_9.png b/doc/user/project/members/img/add_user_imported_members_v13_9.png
deleted file mode 100644
index e40240df2b2..00000000000
--- a/doc/user/project/members/img/add_user_imported_members_v13_9.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/members/img/add_user_list_members_v13_9.png b/doc/user/project/members/img/add_user_list_members_v13_9.png
deleted file mode 100644
index 7a07ea01d14..00000000000
--- a/doc/user/project/members/img/add_user_list_members_v13_9.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/members/img/add_user_search_people_v13_8.png b/doc/user/project/members/img/add_user_search_people_v13_8.png
deleted file mode 100644
index e9aa58512ab..00000000000
--- a/doc/user/project/members/img/add_user_search_people_v13_8.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/project/members/index.md b/doc/user/project/members/index.md
index 127cd4a698f..7dc1a9c612f 100644
--- a/doc/user/project/members/index.md
+++ b/doc/user/project/members/index.md
@@ -6,19 +6,75 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Members of a project
-You can manage the groups and users and their access levels in all of your
-projects. You can also personalize the access level you give each user,
-per-project.
+Members are the users and groups who have access to your project.
-You should have Maintainer or Owner [permissions](../../permissions.md) to add
-or import a new user to your project.
+Each member gets a role, which determines what they can do in the project.
-To view, edit, add, and remove project's members, go to your
-project's **Members**.
+## Add users to a project
+
+Add users to a project so they become members and have permission
+to perform actions.
+
+Prerequisite:
+
+- You must have maintainer or owner [permissions](../../permissions.md).
+
+To add a user to a project:
+
+1. Go to your project and select **Members**.
+1. On the **Invite member** tab, under **GitLab member of Email address**, type the username or email address.
+1. Select a [role](../../permissions.md).
+1. Optional. Choose an expiration date. On that date, the user can no longer access the project.
+1. Select **Invite**.
+
+If the user has a GitLab account, they are added to the members list.
+If you used an email address, the user receives an email.
+
+## Add groups to a project
+
+When you assign a group to a project, each user in the group gets access to the project,
+based on the role they're assigned in the group. However, the user's access is also
+limited by the maximum role you choose when you invite the group.
+
+Prerequisite:
+
+- You must have maintainer or owner [permissions](../../permissions.md).
+
+To add groups to a project:
+
+1. Go to your project and select **Members**.
+1. On the **Invite group** tab, under **Select a group to invite**, choose a group.
+1. Select the highest max [role](../../permissions.md) for users in the group.
+1. Optional. Choose an expiration date. On that date, the user can no longer access the project.
+1. Select **Invite**.
+
+The members of the group are not displayed on the **Members** tab.
+The **Members** tab shows:
+
+- Members who are directly assigned to the project.
+- If the project was created in a group [namespace](../../group/index.md#namespaces), members of that group.
+
+## Import users from another project
+
+You can import another project's users to your own project. Users
+retain the same permissions as the project you import them from.
+
+Prerequisite:
+
+- You must have maintainer or owner [permissions](../../permissions.md).
+
+To import users:
+
+1. Go to your project and select **Members**.
+1. On the **Invite member** tab, at the bottom of the panel, select **Import**.
+1. Select the project. You can view only the projects for which you're a maintainer.
+1. Select **Import project members**.
+
+A success message is displayed and the new members are now displayed in the list.
## Inherited membership
-When your project belongs to the group, group members inherit the membership and permission
+When your project belongs to a group, group members inherit the membership and permission
level for the project from the group.
![Project members page](img/project_members_v13_9.png)
@@ -70,48 +126,6 @@ You can sort members by **Account**, **Access granted**, **Max role**, or **Last
![Project members sort](img/project_members_sort_v13_9.png)
-## Add a user
-
-Right next to **People**, start typing the name or username of the user you
-want to add.
-
-![Search for people](img/add_user_search_people_v13_8.png)
-
-Select the user and the [permission level](../../permissions.md)
-that you'd like to give the user. You can add more than one user at a time.
-The Owner role can only be assigned at the group level.
-
-![Give user permissions](img/add_user_give_permissions_v13_8.png)
-
-Once done, select **Add users to project** and they are immediately added to
-your project with the permissions you gave them above.
-
-![List members](img/add_user_list_members_v13_9.png)
-
-From there on, you can either remove an existing user or change their access
-level to the project.
-
-## Import users from another project
-
-You can import another project's users to your own project. Users
-retain the same permissions as the project you import them from.
-
-To import users:
-
-1. Go to your project and select **Members**.
-
-1. On the **Invite member** tab, select **Import**.
-
-1. Select the project. You can only view projects you are Maintainer of.
-
- ![Import members from another project](img/add_user_import_members_from_another_project_v13_8.png)
-
-1. Select **Import project members**. A message displays, notifying you
- that the import was successful, and the new members are now in the project's
- members list.
-
-![Members list of new members](img/add_user_imported_members_v13_9.png)
-
## Invite people using their e-mail address
NOTE:
@@ -240,8 +254,7 @@ requests they are currently assigned or leave the assignments as they are.
To remove a member from a project:
-1. In a project, go to **{users}** **Members**.
-1. Click the **Delete** **{remove}** button next to a project member you want to remove.
- A **Remove member** modal appears.
-1. (Optional) Select the **Also unassign this user from related issues and merge requests** checkbox.
-1. Click **Remove member**.
+1. Go to your project and select **Members**.
+1. Next to the project member you want to remove, select **Remove member** **{remove}**.
+1. Optional. In the confirmation box, select the **Also unassign this user from related issues and merge requests** checkbox.
+1. Select **Remove member**.
diff --git a/doc/user/project/members/share_project_with_groups.md b/doc/user/project/members/share_project_with_groups.md
index 5e5643c7109..085e4db0b94 100644
--- a/doc/user/project/members/share_project_with_groups.md
+++ b/doc/user/project/members/share_project_with_groups.md
@@ -4,7 +4,7 @@ group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Share Projects with other Groups
+# Share projects with other groups
You can share projects with other [groups](../../group/index.md). This makes it
possible to add a group of users to a project with a single action.
diff --git a/doc/user/project/protected_branches.md b/doc/user/project/protected_branches.md
index c66f9038ed2..673a756f18d 100644
--- a/doc/user/project/protected_branches.md
+++ b/doc/user/project/protected_branches.md
@@ -7,46 +7,45 @@ type: reference, howto
# Protected branches **(FREE)**
-[Permissions](../permissions.md) in GitLab are fundamentally defined around the
+In GitLab, [permissions](../permissions.md) are fundamentally defined around the
idea of having read or write permission to the repository and branches. To impose
further restrictions on certain branches, they can be protected.
-## Overview
+The default branch for your repository is protected by default.
-By default, a protected branch does these things:
+## Who can access a protected branch
-- It prevents its creation, if not already created, from everybody except users
- with Maintainer permission.
-- It prevents pushes from everybody except users with **Allowed** permission.
-- It prevents **anyone** from force pushing to the branch.
-- It prevents **anyone** from deleting the branch.
+When a branch is protected, the default behavior enforces
+these restrictions on the branch.
-**Permissions:**
+| Action | Who can do it |
+|--------------------------|---------------|
+| Protect a branch | Maintainers only. |
+| Push to the branch | GitLab administrators and anyone with **Allowed** permission. (*) |
+| Force push to the branch | No one. |
+| Delete the branch | No one. |
-- GitLab administrators are allowed to push to the protected branches.
-- Users with [Developer permissions](../permissions.md) are allowed to
- create a project in a group, but might not be allowed to initially
- push to the [default branch](repository/branches/default.md).
+(*) Users with developer permissions can create a project in a group,
+but might not be allowed to initially push to the [default branch](repository/branches/default.md).
-The default branch protection level is set in the [Admin Area](../admin_area/settings/visibility_and_access_controls.md#default-branch-protection).
+### Set the branch protection default level
-See the [Changelog](#changelog) section for changes over time.
+The default branch protection level is set in the [Admin Area](../admin_area/settings/visibility_and_access_controls.md#default-branch-protection).
-## Configuring protected branches
+## Configure a protected branch
-To protect a branch, you need to have at least Maintainer permission level.
-The default branch for your repository is protected by default.
+Prerequisite:
-1. In your project, go to **Settings > Repository**.
-1. Scroll to find the **Protected branches** section.
-1. From the **Branch** dropdown menu, select the branch you want to protect and
- click **Protect**. In the screenshot below, we chose the `develop` branch.
+- You must have at least maintainer permissions.
- ![Protected branches page](img/protected_branches_page_v12_3.png)
+To protect a branch:
-1. Once done, the protected branch displays in the **Protected branches** list.
+1. Go to your project and select **Settings > Repository**.
+1. Expand **Protected branches**.
+1. From the **Branch** dropdown menu, select the branch you want to protect.
+1. Select **Protect**.
- ![Protected branches list](img/protected_branches_list_v12_3.png)
+The protected branch displays in the **Protected branches** list.
## Using the Allowed to merge and Allowed to push settings
@@ -141,7 +140,7 @@ all matching branches:
![Protected branch matches](img/protected_branches_matches.png)
-## Creating a protected branch
+## Create a protected branch
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/53361) in GitLab 11.9.
@@ -161,7 +160,7 @@ To create a new branch through the user interface:
base the new branch on. Only existing protected branches and commits
that are already in protected branches are accepted.
-## Deleting a protected branch
+## Delete a protected branch
From time to time, you may need to delete or clean up protected branches.
User with [Maintainer permissions](../permissions.md) and greater can manually delete protected