diff options
author | Jacob Vosmaer <contact@jacobvosmaer.nl> | 2014-06-25 15:23:10 +0200 |
---|---|---|
committer | Jacob Vosmaer <contact@jacobvosmaer.nl> | 2014-06-25 15:23:10 +0200 |
commit | 9549be5fe717af5877d46ec6f38be1f86c1eceb6 (patch) | |
tree | bd26cd6e509a4463a1564f8b771e8b9aaad2e78b /doc/workflow | |
parent | 907548a0fbf3c048536c2012bdbdbd10b604c067 (diff) | |
download | gitlab-ce-9549be5fe717af5877d46ec6f38be1f86c1eceb6.tar.gz |
Document the basics of working with Groups
Diffstat (limited to 'doc/workflow')
-rw-r--r-- | doc/workflow/README.md | 1 | ||||
-rw-r--r-- | doc/workflow/groups.md | 71 | ||||
-rw-r--r-- | doc/workflow/groups/add_member_to_group.png | bin | 0 -> 138184 bytes | |||
-rw-r--r-- | doc/workflow/groups/group_dashboard.png | bin | 0 -> 107332 bytes | |||
-rw-r--r-- | doc/workflow/groups/group_with_two_projects.png | bin | 0 -> 129319 bytes | |||
-rw-r--r-- | doc/workflow/groups/new_group_button.png | bin | 0 -> 185406 bytes | |||
-rw-r--r-- | doc/workflow/groups/new_group_form.png | bin | 0 -> 106491 bytes | |||
-rw-r--r-- | doc/workflow/groups/override_access_level.png | bin | 0 -> 157193 bytes | |||
-rw-r--r-- | doc/workflow/groups/project_members_via_group.png | bin | 0 -> 151339 bytes | |||
-rw-r--r-- | doc/workflow/groups/transfer_project.png | bin | 0 -> 164958 bytes |
10 files changed, 72 insertions, 0 deletions
diff --git a/doc/workflow/README.md b/doc/workflow/README.md index c715f6e5943..00d4bed1cc7 100644 --- a/doc/workflow/README.md +++ b/doc/workflow/README.md @@ -1,3 +1,4 @@ - [Workflow](workflow.md) - [Project Features](project_features.md) - [Authorization for merge requests](authorization_for_merge_requests.md) +- [Groups](groups.md) diff --git a/doc/workflow/groups.md b/doc/workflow/groups.md new file mode 100644 index 00000000000..88d977d3aa1 --- /dev/null +++ b/doc/workflow/groups.md @@ -0,0 +1,71 @@ +# GitLab Groups + +GitLab groups allow you to group projects into directories and give users to several projects at once. + +When you create a new project in GitLab, the default namespace for the project is the personal namespace associated with your GitLab user. +In this document we will see how to create groups, put projects in groups and manage who can access the projects in a group. + +## Creating groups + +You can create a group by going to the 'Groups' tab of the GitLab dashboard and clicking the 'New group' button. + +![Click the 'New group' button in the 'Groups' tab](groups/new_group_button.png) + +Next, enter the name (required) and the optional description and group avatar. + +![Fill in the name for your new group](groups/new_group_form.png) + +When your group has been created you are presented with the group dashboard feed, which will be empty. + +![Group dashboard](groups/group_dashboard.png) + +You can use the 'New project' button to add a project to the new group. + +## Transfering an existing project into a group + +You can transfer an existing project into a group you own from the project settings page. +First scroll down to the 'Dangerous settings' and click 'Show them to me'. +Now you can pick any of the groups you manage as the new namespace for the group. + +![Transfer a project to a new namespace](groups/transfer_project.png) + +GitLab administrators can use the admin interface to move any project to any namespace if needed. + +## Adding users to a group + +One of the benefits of putting multiple projects in one group is that you can give a user to access to all projects in the group with one action. + +Suppose we have a group with two projects. + +![Group with two projects](groups/groups/group_with_two_projects.png) + +On the 'Group Members' page we can now add a new user Barry to the group. + +![Add user Barry to the group](groups/add_member_to_group.png) + +Now because Barry is a 'Developer' member of the 'Open Source' group, he automatically gets 'Developer' access to all projects in the 'Open Source' group. + +![Barry has 'Developer' access to GitLab CI](groups/project_members_via_group.png) + +If necessary, you can increase the access level of an individual user for a specific project, by adding them as a Member to the project. + +![Barry effectively has 'Master' access to GitLab CI now](groups/override_access_level.png) + +## Managing group memberships via LDAP + +In GitLab Enterprise Edition it is possible to manage GitLab group memberships using LDAP groups. +See [the GitLab Enterprise Edition documentation](http://doc.gitlab.com/ee/integration/ldap.html) for more information. + +## Allowing only admins to create groups + +By default, any GitLab user can create new groups. +This ability can be disabled for individual users from the admin panel. +It is also possible to configure GitLab so that new users default to not being able to create groups: + +``` +# For omnibus-gitlab, put the following in /etc/gitlab/gitlab.rb +gitlab_rails['gitlab_default_can_create_group'] = false + +# For installations from source, uncomment the 'default_can_create_group' +# line in /home/git/gitlab/config/gitlab.yml +``` diff --git a/doc/workflow/groups/add_member_to_group.png b/doc/workflow/groups/add_member_to_group.png Binary files differnew file mode 100644 index 00000000000..fa340ce572f --- /dev/null +++ b/doc/workflow/groups/add_member_to_group.png diff --git a/doc/workflow/groups/group_dashboard.png b/doc/workflow/groups/group_dashboard.png Binary files differnew file mode 100644 index 00000000000..7fc9048d74d --- /dev/null +++ b/doc/workflow/groups/group_dashboard.png diff --git a/doc/workflow/groups/group_with_two_projects.png b/doc/workflow/groups/group_with_two_projects.png Binary files differnew file mode 100644 index 00000000000..87242781e4f --- /dev/null +++ b/doc/workflow/groups/group_with_two_projects.png diff --git a/doc/workflow/groups/new_group_button.png b/doc/workflow/groups/new_group_button.png Binary files differnew file mode 100644 index 00000000000..51e82798658 --- /dev/null +++ b/doc/workflow/groups/new_group_button.png diff --git a/doc/workflow/groups/new_group_form.png b/doc/workflow/groups/new_group_form.png Binary files differnew file mode 100644 index 00000000000..bf992c40bc2 --- /dev/null +++ b/doc/workflow/groups/new_group_form.png diff --git a/doc/workflow/groups/override_access_level.png b/doc/workflow/groups/override_access_level.png Binary files differnew file mode 100644 index 00000000000..f4225a63679 --- /dev/null +++ b/doc/workflow/groups/override_access_level.png diff --git a/doc/workflow/groups/project_members_via_group.png b/doc/workflow/groups/project_members_via_group.png Binary files differnew file mode 100644 index 00000000000..b13cb1cfd95 --- /dev/null +++ b/doc/workflow/groups/project_members_via_group.png diff --git a/doc/workflow/groups/transfer_project.png b/doc/workflow/groups/transfer_project.png Binary files differnew file mode 100644 index 00000000000..044fe10d073 --- /dev/null +++ b/doc/workflow/groups/transfer_project.png |