Skip to content

Commit adb09f6

Browse files
Suzanne Selhorneread
Suzanne Selhorn
authored andcommitted
Edited top section of topic
Related to: https://gitlab.com/gitlab-org/gitlab/-/issues/300312
1 parent 91747f8 commit adb09f6

File tree

9 files changed

+50
-74
lines changed

9 files changed

+50
-74
lines changed

Diff for: doc/ci/environments/protected_environments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Alternatively, you can use the API to protect an environment:
7070
name: ${CI_JOB_NAME}
7171
```
7272
73-
1. Use the UI to [create a new group](../../user/group/index.md#create-a-new-group).
73+
1. Use the UI to [create a new group](../../user/group/index.md#create-a-group).
7474
For example, this group is called `protected-access-group` and has the group ID `9899826`. Note
7575
that the rest of the examples in these steps use this group.
7676

Diff for: doc/gitlab-basics/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The following are guides to basic GitLab functionality:
2323

2424
- [Create and add your SSH public key](../ssh/README.md), for enabling Git over SSH.
2525
- [Create a project](../user/project/working_with_projects.md#create-a-project), to start using GitLab.
26-
- [Create a group](../user/group/index.md#create-a-new-group), to combine and administer
26+
- [Create a group](../user/group/index.md#create-a-group), to combine and administer
2727
projects together.
2828
- [Create a branch](create-branch.md), to make changes to files stored in a project's repository.
2929
- [Feature branch workflow](feature_branch_workflow.md).

Diff for: doc/intro/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ comments: false
1212
Create projects and groups.
1313

1414
- [Create a new project](../user/project/working_with_projects.md#create-a-project)
15-
- [Create a new group](../user/group/index.md#create-a-new-group)
15+
- [Create a new group](../user/group/index.md#create-a-group)
1616

1717
## Prioritize
1818

Diff for: doc/user/admin_area/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ sort order is by **Last created**.
203203
To search for groups by name, enter your criteria in the search field. The group search is case
204204
insensitive, and applies partial matching.
205205

206-
To [Create a new group](../group/index.md#create-a-new-group) click **New group**.
206+
To [Create a new group](../group/index.md#create-a-group) click **New group**.
207207

208208
### Administering Jobs
209209

Diff for: doc/user/group/img/groups.png

-60.1 KB
Binary file not shown.

Diff for: doc/user/group/index.md

+42-66
Original file line numberDiff line numberDiff line change
@@ -7,90 +7,54 @@ info: To determine the technical writer assigned to the Stage/Group associated w
77

88
# Groups
99

10-
With GitLab Groups, you can:
10+
In GitLab, you can put related projects together in a group.
1111

12-
- Assemble related projects together.
13-
- Grant members access to several projects at once.
12+
For example, you might create a group for your company members and a subgroup for each individual team.
13+
You can name the group `company-team`, and the subgroups `backend-team`, `frontend-team`, and `production-team`.
1414

15-
For a video introduction to GitLab Groups, see [GitLab University: Repositories, Projects and Groups](https://www.youtube.com/watch?v=4TWfh1aKHHw).
15+
Then you can:
1616

17-
Groups can also be nested in [subgroups](subgroups/index.md).
17+
- Grant members access to multiple projects at once.
18+
- Add to-do items for all of the group members at once.
19+
- View the [issues](../project/issues/index.md#issues-list) and
20+
[merge requests](../project/merge_requests/reviewing_and_managing_merge_requests.md#view-merge-requests-for-all-projects-in-a-group)
21+
for all projects in the group, together in a single list view.
22+
- [Bulk edit](../group/bulk_editing/index.md) issues, epics, and merge requests.
1823

19-
Find your groups by clicking **Groups > Your Groups** in the top navigation.
24+
You can also create [subgroups](subgroups/index.md).
2025

21-
![GitLab Groups](img/groups.png)
26+
## View groups
2227

23-
> The **Groups** dropdown in the top navigation was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/36234) in [GitLab 11.1](https://about.gitlab.com/releases/2018/07/22/gitlab-11-1-released/#groups-dropdown-in-navigation).
28+
To view groups:
2429

25-
The **Groups** page displays:
30+
1. In the top menu, select **Groups > Your Groups**. All groups you are a member of are displayed.
31+
1. To view a list of public groups, select **Explore public groups**.
2632

27-
- All groups you are a member of, when **Your groups** is selected.
28-
- A list of public groups, when **Explore public groups** is selected.
33+
You can also view groups by namespace.
2934

30-
Each group on the **Groups** page is listed with:
35+
### Namespaces
3136

32-
- How many subgroups it has.
33-
- How many projects it contains.
34-
- How many members the group has, not including members inherited from parent group(s).
35-
- The group's visibility.
36-
- A link to the group's settings, if you have sufficient permissions.
37-
- A link to leave the group, if you are a member.
38-
39-
## Use cases
40-
41-
You can create groups for numerous reasons. To name a couple:
42-
43-
- Grant access to multiple projects and multiple team members in fewer steps by organizing related projects under the same [namespace](#namespaces) and adding members to the top-level group.
44-
- Make it easier to `@mention` all of your team at once in issues and merge requests by creating a group and including the appropriate members.
45-
46-
For example, you could create a group for your company members, and create a [subgroup](subgroups/index.md) for each individual team. Let's say you create a group called `company-team`, and you create subgroups in this group for the individual teams `backend-team`, `frontend-team`, and `production-team`.
47-
48-
- When you start a new implementation from an issue, you add a comment:
49-
_"`@company-team`, let's do it! `@company-team/backend-team` you're good to go!"_
50-
- When your backend team needs help from frontend, they add a comment:
51-
_"`@company-team/frontend-team` could you help us here please?"_
52-
- When the frontend team completes their implementation, they comment:
53-
_"`@company-team/backend-team`, it's done! Let's ship it `@company-team/production-team`!"_
54-
55-
## Namespaces
56-
57-
In GitLab, a namespace is a unique name to be used as a user name, a group name, or a subgroup name.
37+
In GitLab, a namespace is a unique name and URL for a user, a group, or subgroup.
5838

5939
- `http://gitlab.example.com/username`
6040
- `http://gitlab.example.com/groupname`
6141
- `http://gitlab.example.com/groupname/subgroup_name`
6242

6343
For example, consider a user named Alex:
6444

65-
1. Alex creates an account on GitLab.com with the username `alex`;
66-
their profile will be accessed under `https://gitlab.example.com/alex`
67-
1. Alex creates a group for their team with the group name `alex-team`;
68-
the group and its projects will be accessed under `https://gitlab.example.com/alex-team`
69-
1. Alex creates a subgroup of `alex-team` with the subgroup name `marketing`;
70-
this subgroup and its projects will be accessed under `https://gitlab.example.com/alex-team/marketing`
71-
72-
By doing so:
73-
74-
- Any team member mentions Alex with `@alex`
75-
- Alex mentions everyone from their team with `@alex-team`
76-
- Alex mentions only the marketing team with `@alex-team/marketing`
45+
1. Alex creates an account with the username `alex`: `https://gitlab.example.com/alex`
46+
1. Alex creates a group for their team with the group name `alex-team`.
47+
The group and its projects are available at: `https://gitlab.example.com/alex-team`
48+
1. Alex creates a subgroup of `alex-team` with the subgroup name `marketing`.
49+
The subgroup and its projects are available at: `https://gitlab.example.com/alex-team/marketing`
7750

78-
## Issues and merge requests within a group
51+
## Create a group
7952

80-
Issues and merge requests are part of projects. For a given group, you can view all of the
81-
[issues](../project/issues/index.md#issues-list) and [merge requests](../project/merge_requests/reviewing_and_managing_merge_requests.md#view-merge-requests-for-all-projects-in-a-group) across all projects in that group,
82-
together in a single list view.
83-
84-
### Bulk editing issues and merge requests
85-
86-
For details, see [bulk editing issues and merge requests](../group/bulk_editing/index.md).
87-
88-
## Create a new group
89-
90-
> For a list of words that are not allowed to be used as group names see the
91-
> [reserved names](../reserved_names.md).
53+
NOTE:
54+
For a list of words that can not be used as group names, see
55+
[reserved names](../reserved_names.md).
9256

93-
To create a new Group, either:
57+
To create a new group, either:
9458

9559
- In the top menu, click **Groups** and then **Your Groups**, and click the green button **New group**.
9660

@@ -166,7 +130,7 @@ If you change your mind before your request is approved, just click the
166130

167131
![Withdraw access request button](img/withdraw_access_request_button.png)
168132

169-
## Changing the owner of a group
133+
## Change the owner of a group
170134

171135
Ownership of a group means at least one of its members has
172136
[Owner permission](../permissions.md#group-members-permissions). Groups must have at
@@ -266,6 +230,18 @@ You can sort members by **Account**, **Access granted**, **Max role**, or **Last
266230

267231
![Group members sort](img/group_members_sort_13_7.png)
268232

233+
## Mention a group in an issue or merge request
234+
235+
When you mention a group in a comment, every member of the group gets a to-do item
236+
added to their To-do list.
237+
238+
1. Open the MR or issue.
239+
1. In a comment, type `@` followed by the user, group, or subgroup namespace.
240+
For example, `@alex`, `@alex-team`, or `@alex-team/marketing`.
241+
1. Select **Comment**.
242+
243+
A to-do item is created for all the group and subgroup members.
244+
269245
## Changing the default branch protection of a group
270246

271247
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7583) in GitLab 12.9.
@@ -520,7 +496,7 @@ the group's dashboard, and clicking **Settings**.
520496
### General settings
521497

522498
In addition to editing any settings you previously
523-
set when [creating the group](#create-a-new-group), you can also
499+
set when [creating the group](#create-a-group), you can also
524500
access further configurations for your group.
525501

526502
#### Changing a group's path

Diff for: doc/user/project/clusters/protect/container_host_security/quick_start_guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ applications through GMAv2 exclusively when using Container Network Security.
1515
The following steps are recommended to install and use Container Host Security through GitLab:
1616

1717
1. [Install at least one runner and connect it to GitLab](https://docs.gitlab.com/runner/).
18-
1. [Create a group](../../../../group/#create-a-new-group).
18+
1. [Create a group](../../../../group/#create-a-group).
1919
1. [Connect a Kubernetes cluster to the group](../../add_remove_clusters.md).
2020
1. [Create a cluster management project and associate it with the Kubernetes cluster](../../../../clusters/management_project.md).
2121

Diff for: doc/user/project/clusters/protect/container_network_security/quick_start_guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ applications through GMAv2 exclusively when using Container Network Security.
1515
The following steps are recommended to install and use Container Network Security through GitLab:
1616

1717
1. [Install at least one runner and connect it to GitLab](https://docs.gitlab.com/runner/).
18-
1. [Create a group](../../../../group/#create-a-new-group).
18+
1. [Create a group](../../../../group/#create-a-group).
1919
1. [Connect a Kubernetes cluster to the group](../../add_remove_clusters.md).
2020
1. [Create a cluster management project and associate it with the Kubernetes cluster](../../../../clusters/management_project.md).
2121

Diff for: doc/user/project/merge_requests/merge_request_approvals.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,14 @@ to push or merge code to any branches.
138138

139139
To enable this access:
140140

141-
1. [Create a new group](../../group/index.md#create-a-new-group), and then
141+
1. [Create a new group](../../group/index.md#create-a-group), and then
142142
[add the user to the group](../../group/index.md#add-users-to-a-group),
143143
ensuring you select the Reporter role for the user.
144144
1. [Share the project with your group](../members/share_project_with_groups.md#sharing-a-project-with-a-group-of-users),
145145
based on the Reporter role.
146146
1. Navigate to your project's **Settings > General**, and in the
147147
**Merge request approvals** section, click **Expand**.
148-
1. [Add the group](../../group/index.md#create-a-new-group) to the permission list
148+
1. [Add the group](../../group/index.md#create-a-group) to the permission list
149149
for the protected branch.
150150

151151
![Update approval rule](img/update_approval_rule_v13_4.png)

0 commit comments

Comments
 (0)