diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-07 15:11:20 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-07 15:11:20 +0300 |
commit | 8e81ce50767bd5c785072c2487ffb61fe075977c (patch) | |
tree | 87fe3686b23f2581843a068d0278ee4018931c3f /doc/user | |
parent | 0125f11d6bf7af5817dce9d87a116e2ed6bd1917 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/analytics/analytics_dashboards.md | 54 | ||||
-rw-r--r-- | doc/user/analytics/contributor_analytics.md | 48 | ||||
-rw-r--r-- | doc/user/analytics/contributor_statistics.md | 51 | ||||
-rw-r--r-- | doc/user/analytics/index.md | 2 | ||||
-rw-r--r-- | doc/user/analytics/value_streams_dashboard.md | 4 | ||||
-rw-r--r-- | doc/user/group/saml_sso/group_sync.md | 12 | ||||
-rw-r--r-- | doc/user/project/members/index.md | 16 | ||||
-rw-r--r-- | doc/user/project/repository/index.md | 4 |
8 files changed, 134 insertions, 57 deletions
diff --git a/doc/user/analytics/analytics_dashboards.md b/doc/user/analytics/analytics_dashboards.md index f80470b9296..47eb817116a 100644 --- a/doc/user/analytics/analytics_dashboards.md +++ b/doc/user/analytics/analytics_dashboards.md @@ -100,6 +100,60 @@ To view a list of dashboards (both built-in and custom) for a project: 1. Select **Analyze > Analytics dashboards**. 1. From the list of available dashboards, select the dashboard you want to view. +### View the value streams dashboard + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137483) in GitLab 16.7 [with a flag](../../administration/feature_flags.md) named `project_analytics_dashboard_dynamic_vsd`. Disabled by default. + +FLAG: +On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `combined_analytics_dashboards` and `project_analytics_dashboard_dynamic_vsd`. +On GitLab.com, this feature is not available. +This feature is not ready for production use. + +Prerequisites: + +- You must have at least the Reporter role for the project. +- Overview background aggregation for Value Streams Dashboards must be enabled. + +To view the Value Streams Dashboard as an analytics dashboard for a project: + +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Analyze > Analytics dashboards**. +1. From the list of available dashboards, select **Value Streams Dashboard**. + +## View group dashboards + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390542) in GitLab 16.2 [with a flag](../../administration/feature_flags.md) named `group_analytics_dashboards`. Disabled by default. + +FLAG: +On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `group_analytics_dashboards`. +On GitLab.com, this feature is not available. +This feature is not ready for production use. + +Prerequisites: + +- You must have at least the Reporter role for the group. + +To view a list of dashboards (both built-in and custom) for a group: + +1. On the left sidebar, select **Search or go to** and find your group. +1. Select **Analyze > Analytics dashboards**. +1. From the list of available dashboards, select the dashboard you want to view. + +### View the value streams dashboard + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132839) in GitLab 16.6 [with a flag](../../administration/feature_flags.md) named `group_analytics_dashboard_dynamic_vsd`. Disabled by default. + +FLAG: +On self-managed GitLab, by default this feature is available. To hide the feature per project or for your entire instance, an administrator can [disable the feature flag](../../administration/feature_flags.md) named `group_analytics_dashboard_dynamic_vsd`. +On GitLab.com, this feature is not available. +This feature is not ready for production use. + +To view the Value Streams Dashboard as an analytics dashboard for a group: + +1. On the left sidebar, select **Search or go to** and find your group. +1. Select **Analyze > Analytics dashboards**. +1. From the list of available dashboards, select **Value Streams Dashboard**. + ## Change the location of dashboards You can change the location of your project or group dashboards. diff --git a/doc/user/analytics/contributor_analytics.md b/doc/user/analytics/contributor_analytics.md new file mode 100644 index 00000000000..26dd79533a3 --- /dev/null +++ b/doc/user/analytics/contributor_analytics.md @@ -0,0 +1,48 @@ +--- +stage: Plan +group: Optimize +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Contributor analytics **(FREE ALL)** + +Contributor analytics give you an overview of the commits made by projects members to a project over time. + +## View contributor analytics + +The contributor analytics page displays a line chart with the number of commits to the selected project branch over time, +and line charts with the number of commits by each project member. + +To view contributor analytics for a project: + +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Analyze > Contributor analytics**. +1. From the **Branches** (**main**) dropdown list, select the branch you want to view commits for. +1. To view the number of commits made on a specific day, hover over the line chart. +1. Optional. To display commits only for a specific time period, select the pause icons (**{status-paused}**) and slide them along the horizontal axis: + + - To change the start date, slide the left pause icon to the left or right. + - To change the end date, slide the right pause icon to the left or right. + +## View project commit history + +To view a list of commits made by project members per day: + +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Analyze > Contributor analytics**. +1. Select **History**. +1. From the **Branches** (**main**) dropdown list, select the branch you want to view commits for. +1. To view the number of commits made by the members on a specific day, hover over the line chart. +1. Optional. Filter the results. + + - To filter by author, from the **Author** dropdown list, select the user whose commits you want to view. + - To filter by commit message, in the text box, enter your search criteria. + +## Retrieve project commits as an RSS feed + +To view the list of commits to the project as an RSS feed in Atom format: + +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Analyze > Contributor analytics**. +1. Select **History**. +1. In the upper-right corner, select the feed symbol (**{rss}**). diff --git a/doc/user/analytics/contributor_statistics.md b/doc/user/analytics/contributor_statistics.md index 37ba852b16f..b6f195e22ad 100644 --- a/doc/user/analytics/contributor_statistics.md +++ b/doc/user/analytics/contributor_statistics.md @@ -1,48 +1,11 @@ --- -stage: Plan -group: Optimize -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +redirect_to: 'contributor_analytics.md' +remove_date: '2023-03-06' --- -# Contributor statistics **(FREE ALL)** +This document was moved to [another location](contributor_analytics.md). -Contributor statistics give you an overview of the commits made by projects members to a project over time. - -## View contributor statistics - -The contributor statistics page displays a line chart with the number of commits to the selected project branch over time, -and line charts with the number of commits by each project member. - -To view contributor statistics for a project: - -1. On the left sidebar, select **Search or go to** and find your project. -1. Select **Analyze > Contributor statistics**. -1. From the **Branches** (**main**) dropdown list, select the branch you want to view commits for. -1. To view the number of commits made on a specific day, hover over the line chart. -1. Optional. To display commits only for a specific time period, select the pause icons (**{status-paused}**) and slide them along the horizontal axis: - - - To change the start date, slide the left pause icon to the left or right. - - To change the end date, slide the right pause icon to the left or right. - -## View project commit history - -To view a list of commits made by project members per day: - -1. On the left sidebar, select **Search or go to** and find your project. -1. Select **Analyze > Contributor statistics**. -1. Select **History**. -1. From the **Branches** (**main**) dropdown list, select the branch you want to view commits for. -1. To view the number of commits made by the members on a specific day, hover over the line chart. -1. Optional. Filter the results. - - - To filter by author, from the **Author** dropdown list, select the user whose commits you want to view. - - To filter by commit message, in the text box, enter your search criteria. - -## Retrieve project commits as an RSS feed - -To view the list of commits to the project as an RSS feed in Atom format: - -1. On the left sidebar, select **Search or go to** and find your project. -1. Select **Analyze > Contributor statistics**. -1. Select **History**. -1. In the upper-right corner, select the feed symbol (**{rss}**). +<!-- This redirect file can be deleted after <YYYY-MM-DD>. --> +<!-- Redirects that point to other docs in the same project expire in three months. --> +<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/analytics/index.md b/doc/user/analytics/index.md index e015c68a9be..d58426bd76b 100644 --- a/doc/user/analytics/index.md +++ b/doc/user/analytics/index.md @@ -37,7 +37,7 @@ Use project-level analytics to get insights into your projects': - [Security Dashboards](../application_security/security_dashboard/index.md) - [CI/CD analytics and DORA metrics](ci_cd_analytics.md) - [Code review analytics](code_review_analytics.md) -- [Contributor statistics](../../user/analytics/contributor_statistics.md) +- [Contributor analytics](../../user/analytics/contributor_analytics.md) - [Insights](../project/insights/index.md) - [Issue analytics](../../user/analytics/issue_analytics.md) - [Merge request analytics](merge_request_analytics.md), enabled with the `project_merge_request_analytics` diff --git a/doc/user/analytics/value_streams_dashboard.md b/doc/user/analytics/value_streams_dashboard.md index 3b933688458..7321ddfc15b 100644 --- a/doc/user/analytics/value_streams_dashboard.md +++ b/doc/user/analytics/value_streams_dashboard.md @@ -29,6 +29,8 @@ With the Value Streams Dashboard, you can: - Understand security exposure. - Drill down into individual projects or metrics to take actions for improvement. +The Value Streams Dashboard has a default configuration, but you can also [customize the dashboard panels](#customize-the-dashboard-panels). + ## DevSecOps metrics comparison panel The DevSecOps metrics comparison displays DORA4, vulnerability, and flow metrics for a group or project in the @@ -130,6 +132,8 @@ To view the value streams dashboard: 1. Below the **Filter results** text box, in the **Lifecycle metrics** row, select **Value Streams Dashboard / DORA**. 1. Optional. To open the new page, append this path `/analytics/dashboards/value_streams_dashboard` to the group URL (for example, `https://gitlab.com/groups/gitlab-org/-/analytics/dashboards/value_streams_dashboard`). +You can also view the Value Streams Dashboard rendered as an analytics dashboard for a [group](analytics_dashboards.md#view-group-dashboards) or [project](analytics_dashboards.md#view-project-dashboards). + ## Customize the dashboard panels You can customize the Value Streams Dashboard and configure what subgroups and projects to include in the page. diff --git a/doc/user/group/saml_sso/group_sync.md b/doc/user/group/saml_sso/group_sync.md index 1dc295bdde3..1b5e8414ee7 100644 --- a/doc/user/group/saml_sso/group_sync.md +++ b/doc/user/group/saml_sso/group_sync.md @@ -80,15 +80,17 @@ When SAML is enabled, users with the Maintainer or Owner role see a new menu item in group **Settings > SAML Group Links**. - You can configure one or more **SAML Group Links** to map a SAML identity -provider group name to a GitLab role. + provider group name to a GitLab role. - Members of the SAML identity provider group are added as members of the GitLab -group on their next SAML sign-in. + group on their next SAML sign-in. - Group membership is evaluated each time a user signs in using SAML. - SAML Group Links can be configured for a top-level group or any subgroup. - SAML Group Sync only manages a group if that group has one or more SAML group -links. - - If a SAML group link is created then removed, the user remains in the -group until they are removed from the group in the identity provider. + links. If a SAML group link is created then removed, and there are: + - Other SAML group links configured, users that were in the removed group + link are automatically removed from the group during sync. + - No other SAML group links configured, users remain in the group during sync. + Those users must be manually removed from the group. Prerequisites: diff --git a/doc/user/project/members/index.md b/doc/user/project/members/index.md index c1a73e63e29..92aaee1ae54 100644 --- a/doc/user/project/members/index.md +++ b/doc/user/project/members/index.md @@ -335,10 +335,10 @@ The following table lists the membership and visibility rights of project member | Action | Direct project member | Inherited project member | Direct shared project member | Inherited shared project member | | --- | ------------------- | ---------------------- | -------------------------- | ----------------------------- | | Generate boards | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | -| View issues of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | +| View issues of parent groups <sup>1</sup> | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | View labels of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | View milestones of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | -| Be shared into other groups | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No| +| Be shared into other groups | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | | Be imported into other projects | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | | Share the project with other members | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | @@ -350,9 +350,14 @@ The following table lists the membership and visibility rights of group members. | View issues of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | View labels of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | | View milestones of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | -| Be shared into other groups | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No | -| Be shared into other projects | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | -| Share the group with other members | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | + +<html> +<small>Footnotes: + <ol> + <li>Users can view only issues of projects they have access to.</li> + </ol> +</small> +</html> In the following example, `User` is a: @@ -373,3 +378,4 @@ graph TD User-. member .- subgroup class User user +``` diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index fff4174d939..3640a54149a 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -255,9 +255,9 @@ The size can differ slightly from one instance to another due to compression, ho Administrators can set a [repository size limit](../../../administration/settings/account_and_limit_settings.md). [GitLab sets the size limits for GitLab.com](../../gitlab_com/index.md#account-and-limit-settings). -## Repository contributor statistics +## Repository contributor analytics -You can view a list and charts of commits made by project members in [Contributor statistics](../../analytics/contributor_statistics.md). +You can view a list and charts of commits made by project members in [Contributor analytics](../../analytics/contributor_analytics.md). ## Repository history graph |