Skip to content
Snippets Groups Projects
Verified Commit a3461331 authored by Lorena Ciutacu's avatar Lorena Ciutacu Committed by GitLab
Browse files

Update preposition of "role" in docs

parent b1466b51
No related branches found
No related tags found
1 merge request!164176Update preposition of "role" in docs
Showing
with 48 additions and 48 deletions
......@@ -24,7 +24,7 @@ External users:
- Can only access public snippets.
Access can be granted by adding the user as member to the project or group.
Like usual users, they receive a role in the project or group with all
Like usual users, they receive a role for the project or group with all
the abilities that are mentioned in the [permissions table](../user/permissions.md#project-members-permissions).
For example, if an external user is added as Guest, and your project is internal or
private, they do not have access to the code; you need to grant the external
......
......@@ -132,7 +132,7 @@ Parameters:
## Delete group milestone
Only for users with the Developer role in the group.
Only for users with the Developer role for the group.
```plaintext
DELETE /groups/:id/milestones/:milestone_id
......
......@@ -1541,7 +1541,7 @@ by the group or subgroups.
This endpoint is an [experiment](../policy/experiment-beta-support.md) and might be changed or removed without notice.
Requires Owner role in the group.
Requires Owner role for the group.
```plaintext
GET /groups/:id/users
......@@ -2745,7 +2745,7 @@ details are returned in the response.
The following criteria must be met:
- The group must be a top-level group.
- You must have the Owner role in the group.
- You must have the Owner role for the group.
- The token type is one of:
- Personal access token
- Group access token
......
......@@ -296,7 +296,7 @@ Delete artifacts of a job.
Prerequisites:
- Must have at least the maintainer role in the project.
- You must have at least the maintainer role for the project.
```plaintext
DELETE /projects/:id/jobs/:job_id/artifacts
......
......@@ -192,7 +192,7 @@ DETAILS:
Prerequisites:
- You must have the Owner role in the group.
- You must have the Owner role for the group.
Use this API to manage group specific member roles. You can only create member roles at the root level of the group.
......
......@@ -124,7 +124,7 @@ Parameters:
> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
Only for users with at least the Reporter role in the project.
Only for users with at least the Reporter role for the project.
```plaintext
DELETE /projects/:id/milestones/:milestone_id
......@@ -171,7 +171,7 @@ Parameters:
> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
Only for users with at least the Reporter role in the group.
Only for users with at least the Reporter role for the group.
```plaintext
POST /projects/:id/milestones/:milestone_id/promote
......
......@@ -2874,10 +2874,10 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git
Import members from another project.
If the importing member's role in the target project is:
If the importing member's role for the target project is:
- Maintainer, then members with the Owner role in the source project are imported with the Maintainer role.
- Owner, then members with the Owner role in the source project are imported with the Owner role.
- Maintainer, then members with the Owner role for the source project are imported with the Maintainer role.
- Owner, then members with the Owner role for the source project are imported with the Owner role.
```plaintext
POST /projects/:id/import_project_members/:project_id
......
......@@ -51,7 +51,7 @@ Get a list of runners available to the user.
Prerequisites:
- You must be an administrator of or have the Owner role in the target namespace or project.
- You must be an administrator of or have the Owner role for the target namespace or project.
- For `instance_type`, you must be an administrator of the GitLab instance.
```plaintext
......@@ -134,7 +134,7 @@ is restricted to users with administrator access.
Prerequisites:
- You must be an administrator of or have the Owner role in the target namespace or project.
- You must be an administrator of or have the Owner role for the target namespace or project.
- For `instance_type`, you must be an administrator of the GitLab instance.
```plaintext
......@@ -240,7 +240,7 @@ Instance-level runner details via this endpoint are available to all authenticat
Prerequisites:
- You must at least the Developer role in the target namespace or project.
- You must have at least the Developer role for the target namespace or project.
- An access token with the `manage_runner` scope and the appropriate role.
```plaintext
......@@ -328,8 +328,8 @@ PUT /runners/:id
Prerequisites:
- For `instance_type`, you must be an administrator of the GitLab instance.
- For `group_type`, you must have the Owner role in the target namespace.
- For `project_type`, you must have at least the Maintainer role in the target project.
- For `group_type`, you must have the Owner role for the target namespace.
- For `project_type`, you must have at least the Maintainer role for the target project.
- An access token with the `manage_runner` scope and the appropriate role.
| Attribute | Type | Required | Description |
......@@ -412,8 +412,8 @@ Pause a runner.
Prerequisites:
- For `instance_type`, you must be an administrator of the GitLab instance.
- For `group_type`, you must have the Owner role in the target namespace.
- For `project_type`, you must have at least the Maintainer role in the target project.
- For `group_type`, you must have the Owner role for the target namespace.
- For `project_type`, you must have at least the Maintainer role for the target project.
- An access token with the `manage_runner` scope and the appropriate role.
```plaintext
......@@ -590,7 +590,7 @@ List all runners available in the project, including from ancestor groups and [a
Prerequisites:
- You must be an administrator of or have at least the Maintainer role in the target project.
- You must be an administrator of or have at least the Maintainer role for the target project.
```plaintext
GET /projects/:id/runners
......@@ -669,8 +669,8 @@ Enable an available project runner in the project.
Prerequisites:
- For `instance_type`, you must be an administrator of the GitLab instance.
- For `group_type`, you must have the Owner role in the target namespace.
- For `project_type`, you must have at least the Maintainer role in the target project.
- For `group_type`, you must have the Owner role for the target namespace.
- For `project_type`, you must have at least the Maintainer role for the target project.
```plaintext
POST /projects/:id/runners
......@@ -719,8 +719,8 @@ returned. Use the call to [delete a runner](#delete-a-runner) instead.
Prerequisites:
- For `instance_type`, you must be an administrator of the GitLab instance.
- For `group_type`, you must have the Owner role in the target namespace.
- For `project_type`, you must have at least the Maintainer role in the target project.
- For `group_type`, you must have the Owner role for the target namespace.
- For `project_type`, you must have at least the Maintainer role for the target project.
```plaintext
DELETE /projects/:id/runners/:runner_id
......@@ -890,8 +890,8 @@ To delete the runner by ID, use your access token with the runner's ID:
Prerequisites:
- For `instance_type`, you must be an administrator of the GitLab instance.
- For `group_type`, you must have the Owner role in the target namespace.
- For `project_type`, you must have at least the Maintainer role in the target project.
- For `group_type`, you must have the Owner role for the target namespace.
- For `project_type`, you must have at least the Maintainer role for the target project.
- An access token with the `manage_runner` scope and the appropriate role.
```plaintext
......@@ -912,7 +912,7 @@ To delete the runner by using its authentication token:
Prerequisites:
- You must be an administrator of or have the Owner role in the target namespace or project.
- You must be an administrator of or have the Owner role for the target namespace or project.
- For `instance_type`, you must be an administrator of the GitLab instance.
```plaintext
......@@ -1024,8 +1024,8 @@ Reset the runner's authentication token by using its runner ID.
Prerequisites:
- For `instance_type`, you must be an administrator of the GitLab instance.
- For `group_type`, you must have the Owner role in the target namespace.
- For `project_type`, you must have at least the Maintainer role in the target project.
- For `group_type`, you must have the Owner role for the target namespace.
- For `project_type`, you must have at least the Maintainer role for the target project.
- An access token with the `manage_runner` scope and the appropriate role.
```plaintext
......
......@@ -563,7 +563,7 @@ in your project, you can select **CI/CD Catalog**.
Visibility of components in the CI/CD catalog follows the component source project's
[visibility setting](../../user/public_access.md). Components with source projects set to:
- Private are visible only to users assigned at least the Guest role in the source component project.
- Private are visible only to users assigned at least the Guest role for the source component project.
- Internal are visible only to users logged into the GitLab instance.
- Public are visible to anyone with access to the GitLab instance.
......@@ -581,7 +581,7 @@ you must set the project as a catalog project.
Prerequisites:
- You must have the Owner role in the project.
- You must have the Owner role for the project.
To set the project as a catalog project:
......@@ -603,7 +603,7 @@ However, publishing a component's releases in the catalog makes it discoverable
Prerequisites:
- You must have at least the Maintainer role in the project.
- You must have at least the Maintainer role for the project.
- The project must:
- Be set as a [catalog project](#set-a-component-project-as-a-catalog-project).
- Have a [project description](../../user/project/working_with_projects.md#edit-project-name-description-and-avatar) defined.
......
......@@ -106,7 +106,7 @@ Add groups or projects to the allowlist only when cross-project access is needed
Prerequisites:
- You must have at least the Maintainer role in the current project. If the allowed project
- You must have at least the Maintainer role for the current project. If the allowed project
is internal or private, you must have at least the Guest role in that project.
- You must not have more than 200 groups and projects added to the allowlist.
......
......@@ -98,7 +98,7 @@ If you set a quota for a subgroup, it is not used.
Prerequisites:
- You must have access to the build to view the total usage and quota summary for a namespace associated with a build.
- Access to **Usage Quotas** page is based on your role in the associated namespace or group.
- Access to **Usage Quotas** page is based on your role for the associated namespace or group.
### View Usage Quota Reports for a group
......
......@@ -37,7 +37,7 @@ To use merge request pipelines:
- Your project's `.gitlab-ci.yml` file must be
[configured with jobs that run in merge request pipelines](#add-jobs-to-merge-request-pipelines).
- You must have at least the Developer role in the
- You must have at least the Developer role for the
source project to run a merge request pipeline.
- Your repository must be a GitLab repository, not an [external repository](../ci_cd_for_external_repos/index.md).
......
......@@ -791,7 +791,7 @@ To change the setting, use [the projects API](../../api/projects.md#edit-project
to modify `ci_pipeline_variables_minimum_override_role` to one of:
- `owner`: Only users with the Owner role can override variables. You must have the Owner
role in the project to change the setting to this value.
role for the project to change the setting to this value.
- `maintainer`: Only users with at least the Maintainer role can override variables.
Default when not specified.
- `developer`: Only users with at least the Developer role can override variables.
......
......@@ -33,7 +33,7 @@ If a component is related to a GitLab feature (for example Secret Detection), th
feature category or is most closely related to it should maintain the project.
In this case, the Engineering Manager for the feature category is assigned as the project owner.
Members with the `owner` role in the project are the DRIs responsible for triaging open issues and merge requests to ensure they get addressed promptly.
Members with the `owner` role for the project are the DRIs responsible for triaging open issues and merge requests to ensure they get addressed promptly.
The component project can be created by a separate team or individual initially but it must be transitioned
to a set of owners before the first version gets published to the catalog.
......
......@@ -37,7 +37,7 @@ current stable branch:
Prerequisites:
- The person requesting the backport does this step. You must have at
least the Developer role in the [Technical Writing project](https://gitlab.com/gitlab-org/technical-writing).
least the Developer role for the [Technical Writing project](https://gitlab.com/gitlab-org/technical-writing).
1. Open an [issue in the Technical Writing project](https://gitlab.com/gitlab-org/technical-writing/-/issues/new)
using the [backport changes template](https://gitlab.com/gitlab-org/technical-writing/-/blob/main/.gitlab/issue_templates/backport_changes.md).
......@@ -92,7 +92,7 @@ For the change to appear in:
Prerequisites:
- The technical writer assigned to the backport does this step. You must have at
least the Maintainer role in the [Technical Writing project](https://gitlab.com/gitlab-org/technical-writing).
least the Maintainer role for the [Technical Writing project](https://gitlab.com/gitlab-org/technical-writing).
After the changes are merged to the appropriate stable branch,
you must update the Docker image that holds that version's documentation.
......
......@@ -35,7 +35,7 @@ appears in the merge request widget. Use the app to go to your changes.
The `review-docs-cleanup` job is triggered automatically on merge. This job deletes the review app.
You must have the Developer role in the project. Users without the Developer role, such
You must have the Developer role for the project. Users without the Developer role, such
as external contributors, cannot run the manual job. In that case, ask someone from
the GitLab team to run the job.
......
......@@ -997,7 +997,7 @@ and should leave it off when you can.
Use **GitLab Duo Workflow**. After first use, use **Duo Workflow**.
Do not use **Workflow** by itself.
Do not use **Workflow** by itself.
## GitLab Flavored Markdown
......@@ -1815,13 +1815,13 @@ Use lowercase for **review app**.
A user has a role **for** a project or group.
Use:
Use:
- You must have the Owner role for the group.
Instead of:
- You must have the Owner role in the group.
- You must have the Owner role for the group.
Do not use **roles** and [**permissions**](#permissions) interchangeably. Each user is assigned a role. Each role includes a set of permissions.
......
......@@ -259,7 +259,7 @@ Git LFS is enabled by default for both self-managed instances and GitLab.com.
Prerequisites:
- You must have at least the Developer role in the project.
- You must have at least the Developer role for the project.
To enable or disable Git LFS at the project level:
......
......@@ -258,10 +258,10 @@ Review the invite errors and try again:
- Alex Smith: Access level should be greater than or equal to Owner inherited membership from group Development
```
> You cannot give Alex a subgroup role with an access level less than their role in the subgroup's parent group, as they have an inherited membership from the parent group.
> You cannot give Alex a subgroup role with an access level less than their role for the subgroup's parent group, as they have an inherited membership from the parent group.
You decide to keep Alex as an Owner in this subgroup as it is appropriate given
their role in the organization. Select **Cancel** to cancel this invite.
their role for the organization. Select **Cancel** to cancel this invite.
The Product Management subgroup has the correct members and roles. Next you will
add users to the Engineering subgroup.
......@@ -339,14 +339,14 @@ Grayson Garcia should be in the **User Experience** subgroup as well.
### Add users to other subgroups
You can add Grayson to the **User Experience** subgroup as a specific role, while
keeping their role in the **Technical Writing** subgroup the same.
keeping their role for the **Technical Writing** subgroup the same.
1. Go to the **User Experience** subgroup.
1. On the left sidebar, select **Subgroup information > Members**. You and Alex
Smith are currently the only members. These are inherited roles.
1. Select **Invite members**.
1. Invite Grayson Garcia as a Developer, a role with a lower level of permissions
than their Maintainer role in the **Technical Writing** subgroup.
than their Maintainer role for the **Technical Writing** subgroup.
This means that Grayson Garcia does not have an unnecessarily high level of permissions
in the User Experience subgroup.
......
......@@ -72,7 +72,7 @@ Prerequisites:
- A custom domain name `example.com` or subdomain `subdomain.example.com`.
- Access to your domain's server control panel to set up a DNS `TXT` record to verify your domain's ownership.
- A project in the group. This project will be linked to the verified domains, and should not be deleted.
- You must have the Owner role in the top-level group.
- You must have the Owner role for the top-level group.
Domain verification applies at the top-level group and to all subgroups and projects
nested under that top-level parent group.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment