From e8d2c2579383897a1dd7f9debd359abe8ae8373d Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Tue, 20 Jul 2021 09:55:51 +0000 Subject: Add latest changes from gitlab-org/gitlab@14-1-stable-ee --- doc/user/group/clusters/index.md | 10 +- doc/user/group/contribution_analytics/index.md | 8 +- doc/user/group/custom_project_templates.md | 59 +++++------- .../img/group_devops_adoption_v14_0.png | Bin 52890 -> 0 bytes .../img/group_devops_adoption_v14_1.png | Bin 0 -> 54919 bytes doc/user/group/devops_adoption/index.md | 53 ++--------- doc/user/group/epics/epic_boards.md | 45 ++++----- doc/user/group/epics/manage_epics.md | 4 +- doc/user/group/import/img/bulk_imports_v13_8.png | Bin 22574 -> 0 bytes doc/user/group/import/img/bulk_imports_v14_1.png | Bin 0 -> 24726 bytes doc/user/group/import/img/import_panel_v13_8.png | Bin 39125 -> 0 bytes doc/user/group/import/img/import_panel_v14_1.png | Bin 0 -> 42789 bytes doc/user/group/import/index.md | 9 +- doc/user/group/index.md | 15 +++ doc/user/group/iterations/index.md | 105 ++++++++++++++++++--- doc/user/group/repositories_analytics/index.md | 2 +- .../group/saml_sso/img/saml_group_links_v13_9.png | Bin 162931 -> 45131 bytes doc/user/group/saml_sso/index.md | 6 +- doc/user/group/settings/img/import_panel_v13_4.png | Bin 23373 -> 0 bytes doc/user/group/settings/img/import_panel_v14_1.png | Bin 0 -> 42789 bytes doc/user/group/settings/import_export.md | 8 +- doc/user/group/subgroups/index.md | 2 +- doc/user/group/value_stream_analytics/index.md | 41 ++++---- 23 files changed, 204 insertions(+), 163 deletions(-) delete mode 100644 doc/user/group/devops_adoption/img/group_devops_adoption_v14_0.png create mode 100644 doc/user/group/devops_adoption/img/group_devops_adoption_v14_1.png delete mode 100644 doc/user/group/import/img/bulk_imports_v13_8.png create mode 100644 doc/user/group/import/img/bulk_imports_v14_1.png delete mode 100644 doc/user/group/import/img/import_panel_v13_8.png create mode 100644 doc/user/group/import/img/import_panel_v14_1.png delete mode 100644 doc/user/group/settings/img/import_panel_v13_4.png create mode 100644 doc/user/group/settings/img/import_panel_v14_1.png (limited to 'doc/user/group') diff --git a/doc/user/group/clusters/index.md b/doc/user/group/clusters/index.md index 4de464822f7..0d885183a41 100644 --- a/doc/user/group/clusters/index.md +++ b/doc/user/group/clusters/index.md @@ -66,7 +66,7 @@ automatically. If you're using [Auto DevOps](../../../topics/autodevops/index.md for deployments with a cluster not managed by GitLab, you must ensure: - The project's deployment service account has permissions to deploy to - [`KUBE_NAMESPACE`](../../project/clusters/index.md#deployment-variables). + [`KUBE_NAMESPACE`](../../project/clusters/deploy_to_cluster.md#deployment-variables). - `KUBECONFIG` correctly reflects any changes to `KUBE_NAMESPACE` (this is [not automatic](https://gitlab.com/gitlab-org/gitlab/-/issues/31519)). Editing `KUBE_NAMESPACE` directly is discouraged. @@ -96,14 +96,14 @@ per [multiple Kubernetes clusters](#multiple-kubernetes-clusters) When specifyin this is automatically set as an environment variable (`KUBE_INGRESS_BASE_DOMAIN`) during the [Auto DevOps](../../../topics/autodevops/index.md) stages. -The domain should have a wildcard DNS configured to the Ingress IP address. [More details](../../project/clusters/index.md#base-domain). +The domain should have a wildcard DNS configured to the Ingress IP address. [More details](../../project/clusters/gitlab_managed_clusters.md#base-domain). ## Environment scopes **(PREMIUM)** When adding more than one Kubernetes cluster to your project, you need to differentiate them with an environment scope. The environment scope associates clusters with [environments](../../../ci/environments/index.md) similar to how the -[environment-specific CI/CD variables](../../../ci/variables/README.md#limit-the-environment-scope-of-a-cicd-variable) +[environment-specific CI/CD variables](../../../ci/variables/index.md#limit-the-environment-scope-of-a-cicd-variable) work. While evaluating which environment matches the environment scope of a @@ -122,7 +122,7 @@ For example, if your project has the following Kubernetes clusters: | Test | `test` | Group | | Development| `*` | Group | -And the following environments are set in [`.gitlab-ci.yml`](../../../ci/yaml/README.md): +And the following environments are set in [`.gitlab-ci.yml`](../../../ci/yaml/index.md): ```yaml stages: @@ -163,7 +163,7 @@ are deployed to the Kubernetes cluster, see the documentation for ## Security of runners For important information about securely configuring runners, see -[Security of runners](../../project/clusters/add_remove_clusters.md#security-of-runners) +[Security of runners](../../project/clusters/cluster_access.md#security-of-runners) documentation for project-level clusters. ## More information diff --git a/doc/user/group/contribution_analytics/index.md b/doc/user/group/contribution_analytics/index.md index 12d7eaf2f12..670ecc48370 100644 --- a/doc/user/group/contribution_analytics/index.md +++ b/doc/user/group/contribution_analytics/index.md @@ -8,12 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3090) in GitLab 12.2 for subgroups. -With Contribution Analytics you can get an overview of the following activity in your -group: - -- Issues -- Merge requests -- Push events +With Contribution Analytics you can get an overview of the [contribution actions](../../../api/events.md#action-types) in your +group. To view the Contribution Analytics, go to your group and select **Analytics > Contribution**. diff --git a/doc/user/group/custom_project_templates.md b/doc/user/group/custom_project_templates.md index d544003536e..41046477b90 100644 --- a/doc/user/group/custom_project_templates.md +++ b/doc/user/group/custom_project_templates.md @@ -9,25 +9,35 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6861) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.6. -Custom project templates are useful for organizations that need to create many similar types of -[projects](../project/index.md). -Projects created from these templates serve as a common starting point. +[Group owners](../permissions.md#group-members-permissions) can set a subgroup to +be the source of project templates that are selectable when a new project is created +in the group. These templates can be selected when you go to **New project > Create from template** +in the group and select the **Group** tab. -## Setting up group-level project templates +Every project in the subgroup, but not nested subgroups, can be selected by members +of the group when a new project is created. -To use a custom project template for a new project: +Repository and database information that is copied over to each new project is identical to the +data exported with the [GitLab Project Import/Export](../project/settings/import_export.md). + +To set custom project templates at the instance level, see [Custom instance-level project templates](../admin_area/custom_project_templates.md). -1. [Create a `templates` subgroup](subgroups/index.md). -1. [Add repositories (projects) to that new subgroup](index.md#add-projects-to-a-group), - as your templates. -1. Edit your group's settings to look to your _templates_ subgroup for templates: +## Set up group-level project templates - 1. In the left menu, select **Settings > General**. If you don't have access to the - group's settings, you may not have sufficient privileges (for example, you may need developer - or higher permissions). - 1. Scroll to **Custom project templates** and select **Expand**. If no **Custom project templates** - section displays, make sure you've created a subgroup and added a project (repository) to it. - 1. Select the **templates** subgroup. +To set up custom project templates in a group, add the subgroup that contains the +project templates to the group settings: + +1. In the group, create a [subgroup](subgroups/index.md). +1. [Add projects to the new subgroup](index.md#add-projects-to-a-group) as your templates. +1. In the left menu for the group, go to **Settings > General**. +1. Expand **Custom project templates** and select the subgroup. + +If all enabled [project features](../project/settings/index.md#sharing-and-permissions) +(except for GitLab Pages) are set to **Everyone With Access**, then every project +template in the subgroup is available to every member of the group. + +Any projects added to the subgroup later can be selected the next time a group member +creates a new project. ### Example structure @@ -54,25 +64,6 @@ gitlab.com/acmeco/ ... ``` -### Adjust Settings - -Users can configure a GitLab group that serves as template source under a group's -**Settings > General > Custom project templates**. - -NOTE: -GitLab administrators can [set project templates for an entire GitLab instance](../admin_area/custom_project_templates.md). - -Within this section, you can configure the group where all the custom project templates are sourced. -If all enabled [project features](../project/settings/index.md#sharing-and-permissions) -(except for GitLab Pages) are set to **Everyone With Access**, then every project template directly -under the group namespace is available to every signed-in user. However, private projects are -available only if the user is a member of the project. Also note that only direct subgroups can be -set as the template source. Projects of nested subgroups of a selected template source cannot be -used. - -Repository and database information that are copied over to each new project are identical to the -data exported with the [GitLab Project Import/Export](../project/settings/import_export.md). - - # Manage epics **(PREMIUM)** This page collects instructions for all the things you can do with [epics](index.md) or in relation @@ -140,6 +138,7 @@ link in the issue sidebar. > - Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.5. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/37081) to the [Premium](https://about.gitlab.com/pricing/) tier in GitLab 12.8. > - Searching by the user's reaction emoji [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/325630) in GitLab 13.11. +> - Sorting by epic titles [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/331625) in GitLab 14.1. You can search for an epic from the list of epics using filtered search bar (similar to that of issues and merge requests) based on following parameters: @@ -162,6 +161,7 @@ You can also sort epics list by: - Last updated - Start date - Due date +- Title Each option contains a button that can toggle the order between **Ascending** and **Descending**. The sort option and order is saved and used wherever you browse epics, including the diff --git a/doc/user/group/import/img/bulk_imports_v13_8.png b/doc/user/group/import/img/bulk_imports_v13_8.png deleted file mode 100644 index ae4d8567d80..00000000000 Binary files a/doc/user/group/import/img/bulk_imports_v13_8.png and /dev/null differ diff --git a/doc/user/group/import/img/bulk_imports_v14_1.png b/doc/user/group/import/img/bulk_imports_v14_1.png new file mode 100644 index 00000000000..fb419c1df6c Binary files /dev/null and b/doc/user/group/import/img/bulk_imports_v14_1.png differ diff --git a/doc/user/group/import/img/import_panel_v13_8.png b/doc/user/group/import/img/import_panel_v13_8.png deleted file mode 100644 index 28d61785098..00000000000 Binary files a/doc/user/group/import/img/import_panel_v13_8.png and /dev/null differ diff --git a/doc/user/group/import/img/import_panel_v14_1.png b/doc/user/group/import/img/import_panel_v14_1.png new file mode 100644 index 00000000000..28417383b6c Binary files /dev/null and b/doc/user/group/import/img/import_panel_v14_1.png differ diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md index 8bf995a4fd9..d76685f992b 100644 --- a/doc/user/group/import/index.md +++ b/doc/user/group/import/index.md @@ -22,6 +22,7 @@ The following resources are migrated to the target instance: - description - attributes - subgroups + - avatar ([Introduced in 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/322904)) - Group Labels ([Introduced in 13.9](https://gitlab.com/gitlab-org/gitlab/-/issues/292429)) - title - description @@ -109,7 +110,7 @@ on an existing group's page. 1. On the New Group page, select **Import group**. - ![Fill in import details](img/import_panel_v13_8.png) + ![Fill in import details](img/import_panel_v14_1.png) 1. Fill in source URL of your GitLab. 1. Fill in [personal access token](../../../user/profile/personal_access_tokens.md) for remote GitLab instance. @@ -118,14 +119,14 @@ on an existing group's page. ### Selecting which groups to import After you have authorized access to the GitLab instance, you are redirected to the GitLab Group -Migration importer page. Your remote GitLab groups, which you have Owner access to, are listed. +Migration importer page. Listed are the remote GitLab groups to which you have the Owner role. 1. By default, the proposed group namespaces match the names as they exist in remote instance, but based on your permissions, you can choose to edit these names before you proceed to import any of them. 1. Select the **Import** button next to any number of groups. -1. The **Status** column shows the import status of each group. You can choose to leave the page open and it will update in real-time. +1. The **Status** column shows the import status of each group. You can choose to leave the page open and it updates in real-time. 1. Once a group has been imported, click its GitLab path to open its GitLab URL. -![Group Importer page](img/bulk_imports_v13_8.png) +![Group Importer page](img/bulk_imports_v14_1.png) diff --git a/doc/user/group/index.md b/doc/user/group/index.md index 15fbb442752..787461f9d96 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -29,6 +29,21 @@ To view groups: You can also view groups by namespace. +### Group visibility + +Like projects, a group can be configured to limit the visibility of it to: + +- Anonymous users. +- All signed-in users. +- Only explicit group members. + +The restriction for [visibility levels](../admin_area/settings/visibility_and_access_controls.md#restricted-visibility-levels) +on the application setting level also applies to groups. If set to internal, the explore page is +empty for anonymous users. The group page has a visibility level icon. + +Administrator users cannot create a subgroup or project with a higher visibility level than that of +the immediate parent group. + ### Namespaces In GitLab, a namespace is a unique name and URL for a user, a group, or subgroup. diff --git a/doc/user/group/iterations/index.md b/doc/user/group/iterations/index.md index 38d209f04ca..5a435f32569 100644 --- a/doc/user/group/iterations/index.md +++ b/doc/user/group/iterations/index.md @@ -11,9 +11,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w > - Deployed behind a feature flag, disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/221047) in GitLab 13.2. > - Enabled on GitLab.com. -> - Able to be enabled or disabled per-group. +> - Can be enabled or disabled per-group. > - Recommended for production use. -> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#disable-iterations). **(PREMIUM ONLY)** +> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#enable-or-disable-iterations). **(PREMIUM ONLY)** > - Moved to GitLab Premium in 13.9. Iterations are a way to track issues over a period of time. This allows teams @@ -32,31 +32,85 @@ In GitLab, iterations are similar to milestones, with a few differences: - Iterations require both a start and an end date. - Iteration date ranges cannot overlap. +## Iteration cadences + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5077) in GitLab 14.1. +> - Deployed behind a [feature flag](../../feature_flags.md), disabled by default. +> - Disabled on GitLab.com. +> - Not recommended for production use. +> - To use in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-iteration-cadences). **(PREMIUM SELF)** + +This in-development feature might not be available for your use. There can be +[risks when enabling features still in development](../../feature_flags.md#risks-when-enabling-features-still-in-development). +Refer to this feature's version history for more details. + +Iteration cadences automate some common iteration tasks. They can be used to +automatically create iterations every 1, 2, 3, 4, or 6 weeks. They can also +be configured to automatically roll over incomplete issues to the next iteration. + +With iteration cadences enabled, you must first +[create an iteration cadence](#create-an-iteration-cadence) before you can +[create an iteration](#create-an-iteration). + +### Create an iteration cadence + +Prerequisites: + +- You must have at least the [Developer role](../../permissions.md) for a group. + +To create an iteration cadence: + +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Issues > Iterations**. +1. Select **New iteration cadence**. +1. Fill out required fields, and select **Create iteration cadence**. The cadence list page opens. + +### Delete an iteration cadence + +Prerequisites: + +- You must have at least the [Developer role](../../permissions.md) for a group. + +Deleting an iteration cadence also deletes all iterations within that cadence. + +To delete an iteration cadence: + +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Issues > Iterations**. +1. Select the three-dot menu (**{ellipsis_v}**) > **Delete cadence** for the cadence you want to delete. +1. Select **Delete cadence** in the confirmation modal. + ## View the iterations list -To view the iterations list, in a group, go to **{issues}** **Issues > Iterations**. -From there you can create a new iteration or click an iteration to get a more detailed view. +To view the iterations list, go to **{issues}** **Issues > Iterations**. +To view all the iterations in a cadence, ordered by descending date, select that iteration cadence. +From there you can create a new iteration or select an iteration to get a more detailed view. ## Create an iteration -NOTE: -You need Developer [permissions](../../permissions.md) or higher to create an iteration. +Prerequisites: + +- You must have at least the [Developer role](../../permissions.md) for a group. + +For manually scheduled iteration cadences, you create and add iterations yourself. To create an iteration: -1. In a group, go to **{issues}** **Issues > Iterations**. -1. Click **New iteration**. +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Issues > Iterations**. +1. Select **New iteration**. 1. Enter the title, a description (optional), a start date, and a due date. -1. Click **Create iteration**. The iteration details page opens. +1. Select **Create iteration**. The iteration details page opens. ## Edit an iteration > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218277) in GitLab 13.2. -NOTE: -You need Developer [permissions](../../permissions.md) or higher to edit an iteration. +Prerequisites: -To edit an iteration, click the three-dot menu (**{ellipsis_v}**) > **Edit iteration**. +- You must have at least the [Developer role](../../permissions.md) for a group. + +To edit an iteration, select the three-dot menu (**{ellipsis_v}**) > **Edit iteration**. ## Add an issue to an iteration @@ -76,7 +130,7 @@ The report also shows a breakdown of total issues in an iteration. Open iteration reports show a summary of completed, unstarted, and in-progress issues. Closed iteration reports show the total number of issues completed by the due date. -To view an iteration report, go to the iterations list page and click an iteration's title. +To view an iteration report, go to the iterations list page and select an iteration's title. ### Iteration burndown and burnup charts @@ -99,13 +153,15 @@ and get a more accurate understanding of scope attributable to each label. To group issues by label: +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Issues > Iterations**. 1. In the **Group by** dropdown, select **Label**. 1. Select the **Filter by label** dropdown. 1. Select the labels you want to group by in the labels dropdown. You can also search for labels by typing in the search input. -1. Click or tap outside of the label dropdown. The page is now grouped by the selected labels. +1. Select or tap outside of the label dropdown. The page is now grouped by the selected labels. -## Disable iterations **(PREMIUM SELF)** +## Enable or disable iterations **(PREMIUM SELF)** GitLab Iterations feature is deployed with a feature flag that is **enabled by default**. [GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) @@ -129,6 +185,25 @@ Feature.disable(:group_iterations) Feature.disable(:group_iterations, Group.find()) ``` +### Enable or disable iteration cadences **(PREMIUM SELF)** + +Iteration Cadences feature is under development and not ready for production use. It is +deployed behind a feature flag that is **disabled by default**. +[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) +can enable it. + +To enable it: + +```ruby +Feature.enable(:iteration_cadences) +``` + +To disable it: + +```ruby +Feature.disable(:iteration_cadences) +``` +