Merge branch '299360-replace-dashboard-with-report-in-docs-and-handbook' into 'master'

Replace 'dashboard' with 'report' in docs and handbook

See merge request gitlab-org/gitlab!66730

doc/administration/compliance.md

@@ -30,4 +30,4 @@ relevant compliance standards.
 |**Separation of Duties using [Protected branches](../user/project/protected_branches.md#require-code-owner-approval-on-a-protected-branch) and [custom CI Configuration Paths](../ci/pipelines/settings.md#specify-a-custom-cicd-configuration-file)**<br> GitLab Premium users can leverage the GitLab cross-project YAML configurations to define deployers of code and developers of code. View the [Separation of Duties Deploy Project](https://gitlab.com/guided-explorations/separation-of-duties-deploy/blob/master/README.md) and [Separation of Duties Project](https://gitlab.com/guided-explorations/separation-of-duties/blob/master/README.md) to see how to use this set up to define these roles. | Premium+ | **{check-circle}** Yes | Project |
 |**[Compliance frameworks](../user/project/settings/index.md#compliance-frameworks)**<br>Create a custom compliance framework at the group level to describe the type of compliance requirements any child project needs to follow. | Premium+ | **{check-circle}** Yes | Group |
 |**[Compliance pipelines](../user/project/settings/index.md#compliance-pipeline-configuration)**<br>Define a pipeline configuration to run for any projects with a given compliance framework. | Ultimate | **{check-circle}** Yes | Group |
-|**[Compliance dashboard](../user/compliance/compliance_dashboard/index.md)**<br>Quickly get visibility into the compliance posture of your organization. | Ultimate | **{check-circle}** Yes | Group |
+|**[Compliance report](../user/compliance/compliance_report/index.md)**<br>Quickly get visibility into the compliance posture of your organization. | Ultimate | **{check-circle}** Yes | Group |

doc/development/export_csv.md

@@ -11,7 +11,7 @@ This document lists the different implementations of CSV export in GitLab codeba
 | Export type | How it works | Advantages | Disadvantages | Existing examples |
 |---|---|---|---|---|
 | Streaming | - Query and yield data in batches to a response stream.<br>- Download starts immediately. | - Report available immediately. | - No progress indicator.<br>- Requires a reliable connection. | [Export Audit Event Log](../administration/audit_events.md#export-to-csv) |
-| Downloading | - Query and write data in batches to a temporary file.<br>- Loads the file into memory.<br>- Sends the file to the client. | - Report available immediately. | - Large amount of data might cause request timeout.<br>- Memory intensive.<br>- Request expires when user navigates to a different page. | [Export Chain of Custody Report](../user/compliance/compliance_dashboard/#chain-of-custody-report) |
+| Downloading | - Query and write data in batches to a temporary file.<br>- Loads the file into memory.<br>- Sends the file to the client. | - Report available immediately. | - Large amount of data might cause request timeout.<br>- Memory intensive.<br>- Request expires when user navigates to a different page. | [Export Chain of Custody Report](../user/compliance/compliance_report/#chain-of-custody-report) |
 | As email attachment | - Asynchronously process the query with background job.<br>- Email uses the export as an attachment. | - Asynchronous processing. | - Requires users use a different app (email) to download the CSV.<br>- Email providers may limit attachment size. | - [Export Issues](../user/project/issues/csv_export.md)<br>- [Export Merge Requests](../user/project/merge_requests/csv_export.md) |
 | As downloadable link in email (*) | - Asynchronously process the query with background job.<br>- Email uses an export link. | - Asynchronous processing.<br>- Bypasses email provider attachment size limit. | - Requires users use a different app (email).<br>- Requires additional storage and cleanup. | [Export User Permissions](https://gitlab.com/gitlab-org/gitlab/-/issues/1772) |
 | Polling (non-persistent state) | - Asynchronously processes the query with the background job.<br>- Frontend(FE) polls every few seconds to check if CSV file is ready. | - Asynchronous processing.<br>- Automatically downloads to local machine on completion.<br>- In-app solution. | - Non-persistable request - request expires when user navigates to a different page.<br>- API is processed for each polling request. | [Export Vulnerabilities](../user/application_security/vulnerability_report/#export-vulnerability-details) |

doc/development/usage_ping/dictionary.md

@@ -386,7 +386,7 @@ Tiers: `premium`, `ultimate`
 
 ### `compliance_unique_visits.g_compliance_dashboard`
 
-Number of unique visitors to the compliance dashboard.
+Number of unique visitors to the compliance report.
 
 [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210216183904_g_compliance_dashboard.yml)
 
@@ -7848,7 +7848,7 @@ Tiers: `free`, `premium`, `ultimate`
 
 ### `counts_monthly.aggregated_metrics.compliance_features_track_unique_visits_union`
 
-Unique users that have used audit event screen, audit event API, compliance dashboard, or credential inventory
+Unique users that have used audit event screen, audit event API, compliance report, or credential inventory
 
 [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210216183201_compliance_features_track_unique_visits_union.yml)
 
@@ -8100,7 +8100,7 @@ Tiers: `free`, `premium`, `ultimate`
 
 ### `counts_weekly.aggregated_metrics.compliance_features_track_unique_visits_union`
 
-Unique users that have used audit event screen, audit event API, compliance dashboard, or credential inventory
+Unique users that have used audit event screen, audit event API, compliance report, or credential inventory
 
 [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210216183211_compliance_features_track_unique_visits_union.yml)
 
@@ -11824,7 +11824,7 @@ Tiers: `premium`, `ultimate`
 
 ### `redis_hll_counters.compliance.g_compliance_dashboard_monthly`
 
-Unique users who have viewed the compliance dashboard in a given month.
+Unique users who have viewed the compliance report in a given month.
 
 [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210216183926_g_compliance_dashboard_monthly.yml)
 
@@ -11838,7 +11838,7 @@ Tiers: `premium`, `ultimate`
 
 ### `redis_hll_counters.compliance.g_compliance_dashboard_weekly`
 
-Unique users who have looked at the compliance dashboard in a given week
+Unique users who have looked at the compliance report in a given week
 
 [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210216183924_g_compliance_dashboard_weekly.yml)
 

doc/user/compliance/compliance_dashboard/index.md

 ---
-type: reference, howto
-stage: Manage
-group: Compliance
-info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
+redirect_to: '../compliance_report/index.md'
+remove_date: '2021-10-23'
 ---
 
-# Compliance Dashboard **(ULTIMATE)**
+This file was moved to [another location](../compliance_report/index.md).
 
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36524) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.8.
-
-The Compliance Dashboard gives you the ability to see a group's merge request activity
-by providing a high-level view for all projects in the group. For example, code approved
-for merging into production.
-
-## Overview
-
-To access the Compliance Dashboard for a group, navigate to **{shield}** **Security & Compliance > Compliance** on the group's menu.
-
-![Compliance Dashboard](img/compliance_dashboard_v13_11.png)
-
-NOTE:
-The Compliance Dashboard shows only the latest MR on each project.
-
-## Merge request drawer
-
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299357) in GitLab 14.1.
-
-When you click on a row, a drawer is shown that provides further details about the merge
-request:
-
-- Project name and [compliance framework label](../../project/settings/index.md#compliance-frameworks),
-  if the project has one assigned.
-- Link to the merge request.
-- The merge request's branch path in the format `[source] into [target]`.
-- A list of users that committed changes to the merge request.
-- A list of users that commented on the merge request.
-- A list of users that approved the merge request.
-- The user that merged the merge request.
-
-## Use cases
-
-This feature is for people who care about the compliance status of projects within their group.
-
-You can use the dashboard to:
-
-- Get an overview of the latest merge request for each project.
-- See if merge requests were approved and by whom.
-- See merge request authors.
-- See the latest [CI Pipeline](../../../ci/pipelines/index.md) result for each merge request.
-
-## Permissions
-
-- On [GitLab Ultimate](https://about.gitlab.com/pricing/) tier.
-- By **Administrators** and **Group Owners**.
-
-## Approval status and separation of duties
-
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217939) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.3.
-
-We support a separation of duties policy between users who create and approve merge requests.
-The approval status column can help you identify violations of this policy.
-Our criteria for the separation of duties is as follows:
-
-- [A merge request author is **not** allowed to approve their merge request](../../project/merge_requests/approvals/settings.md#prevent-authors-from-approving-their-own-work)
-- [A merge request committer is **not** allowed to approve a merge request they have added commits to](../../project/merge_requests/approvals/settings.md#prevent-committers-from-approving-their-own-work)
-- [The minimum number of approvals required to merge a merge request is **at least** two](../../project/merge_requests/approvals/rules.md)
-
-The "Approval status" column shows you, at a glance, whether a merge request is complying with the above.
-This column has four states:
-
-| State | Description |
-|:------|:------------|
-| Empty | The merge request approval status is unknown |
-| ![Failed](img/failed_icon_v13_3.png) | The merge request **does not** comply with any of the above criteria |
-| ![Warning](img/warning_icon_v13_3.png) | The merge request complies with **some** of the above criteria |
-| ![Success](img/success_icon_v13_3.png) | The merge request complies with **all** of the above criteria |
-
-If you do not see the success icon in your Compliance dashboard; please review the above criteria for the merge requests
-project to make sure it complies with the separation of duties described above.
-
-## Chain of Custody report **(ULTIMATE)**
-
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213364) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.3.
-
-The Chain of Custody report allows customers to export a list of merge commits within the group.
-The data provides a comprehensive view with respect to merge commits. It includes the merge commit SHA,
-merge request author, merge request ID, merge user, pipeline ID, group name, project name, and merge request approvers.
-Depending on the merge strategy, the merge commit SHA can either be a merge commit, squash commit or a diff head commit.
-
-To download the Chain of Custody report, navigate to **{shield}** **Security & Compliance > Compliance** on the group's menu and click **List of all merge commits**
-
-### Commit-specific Chain of Custody Report **(ULTIMATE)**
-
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267629) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.6.
-
-You can generate a commit-specific Chain of Custody report for a given commit SHA. To do so, select
-the dropdown next to the **List of all merge commits** button at the top of the Compliance Dashboard.
-
-NOTE:
-The Chain of Custody report download is a CSV file, with a maximum size of 15 MB.
-The remaining records are truncated when this limit is reached.
+<!-- This redirect file can be deleted after <2021-10-23>. -->
+<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page -->

doc/user/compliance/compliance_report/index.md

+---
+type: reference, howto
+stage: Manage
+group: Compliance
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
+---
+
+# Compliance report **(ULTIMATE)**
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36524) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.8.
+> - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/299360) to compliance report in GitLab 14.2.
+
+The compliance report gives you the ability to see a group's merge request activity
+by providing a high-level view for all projects in the group. For example, code approved
+for merging into production.
+
+## Overview
+
+To access the compliance report for a group, navigate to **{shield}** **Security & Compliance > Compliance** on the group's menu.
+
+![Compliance report](img/compliance_report_v13_11.png)
+
+NOTE:
+The compliance report shows only the latest MR on each project.
+
+## Merge request drawer
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299357) in GitLab 14.1.
+
+When you click on a row, a drawer is shown that provides further details about the merge
+request:
+
+- Project name and [compliance framework label](../../project/settings/index.md#compliance-frameworks),
+  if the project has one assigned.
+- Link to the merge request.
+- The merge request's branch path in the format `[source] into [target]`.
+- A list of users that committed changes to the merge request.
+- A list of users that commented on the merge request.
+- A list of users that approved the merge request.
+- The user that merged the merge request.
+
+## Use cases
+
+This feature is for people who care about the compliance status of projects within their group.
+
+You can use the report to:
+
+- Get an overview of the latest merge request for each project.
+- See if merge requests were approved and by whom.
+- See merge request authors.
+- See the latest [CI Pipeline](../../../ci/pipelines/index.md) result for each merge request.
+
+## Permissions
+
+- On [GitLab Ultimate](https://about.gitlab.com/pricing/) tier.
+- By **Administrators** and **Group Owners**.
+
+## Approval status and separation of duties
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217939) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.3.
+
+We support a separation of duties policy between users who create and approve merge requests.
+The approval status column can help you identify violations of this policy.
+Our criteria for the separation of duties is as follows:
+
+- [A merge request author is **not** allowed to approve their merge request](../../project/merge_requests/approvals/settings.md#prevent-authors-from-approving-their-own-work)
+- [A merge request committer is **not** allowed to approve a merge request they have added commits to](../../project/merge_requests/approvals/settings.md#prevent-committers-from-approving-their-own-work)
+- [The minimum number of approvals required to merge a merge request is **at least** two](../../project/merge_requests/approvals/rules.md)
+
+The "Approval status" column shows you, at a glance, whether a merge request is complying with the above.
+This column has four states:
+
+| State | Description |
+|:------|:------------|
+| Empty | The merge request approval status is unknown |
+| ![Failed](img/failed_icon_v13_3.png) | The merge request **does not** comply with any of the above criteria |
+| ![Warning](img/warning_icon_v13_3.png) | The merge request complies with **some** of the above criteria |
+| ![Success](img/success_icon_v13_3.png) | The merge request complies with **all** of the above criteria |
+
+If you do not see the success icon in your compliance report; please review the above criteria for the merge requests
+project to make sure it complies with the separation of duties described above.
+
+## Chain of Custody report **(ULTIMATE)**
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213364) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.3.
+
+The Chain of Custody report allows customers to export a list of merge commits within the group.
+The data provides a comprehensive view with respect to merge commits. It includes the merge commit SHA,
+merge request author, merge request ID, merge user, pipeline ID, group name, project name, and merge request approvers.
+Depending on the merge strategy, the merge commit SHA can either be a merge commit, squash commit or a diff head commit.
+
+To download the Chain of Custody report, navigate to **{shield}** **Security & Compliance > Compliance** on the group's menu and click **List of all merge commits**
+
+### Commit-specific Chain of Custody Report **(ULTIMATE)**
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267629) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.6.
+
+You can generate a commit-specific Chain of Custody report for a given commit SHA. To do so, select
+the dropdown next to the **List of all merge commits** button at the top of the compliance report.
+
+NOTE:
+The Chain of Custody report download is a CSV file, with a maximum size of 15 MB.
+The remaining records are truncated when this limit is reached.

doc/user/compliance/index.md

@@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 The compliance tools provided by GitLab let you keep an eye on various aspects of your project. The
 following compliance tools are available:
 
-- [Compliance Dashboard](compliance_dashboard/index.md): View recent merge request activity across
+- [Compliance report](compliance_report/index.md): View recent merge request activity across
   all projects in a group. This lets you see if merge requests were approved, and by whom.
 - [License Compliance](license_compliance/index.md): Search your project's dependencies for their
   licenses. This lets you determine if the licenses of your project's dependencies are compatible

doc/user/project/merge_requests/approvals/settings.md

@@ -129,5 +129,5 @@ To learn more, see [Coverage check approval rule](../../../../ci/pipelines/setti
 ## Related links
 
 - [Instance-level merge request approval settings](../../../admin_area/merge_requests_approvals.md)
-- [Compliance Dashboard](../../../compliance/compliance_dashboard/index.md)
+- [Compliance report](../../../compliance/compliance_report/index.md)
 - [Merge request approvals API](../../../../api/merge_request_approvals.md)

ee/app/assets/javascripts/compliance_dashboard/components/empty_state.vue

@@ -16,11 +16,11 @@ export default {
   strings: {
     heading: __("A merge request hasn't yet been merged"),
     subheading: __(
-      'The Compliance Report captures merged changes that violate compliance best practices.',
+      'The compliance report captures merged changes that violate compliance best practices.',
     ),
     documentation: __('View documentation'),
   },
-  documentationPath: 'https://docs.gitlab.com/ee/user/compliance/compliance_dashboard/index.html',
+  documentationPath: 'https://docs.gitlab.com/ee/user/compliance/compliance_report/index.html',
 };
 </script>
 

ee/app/assets/javascripts/compliance_dashboard/components/merge_requests/statuses/approval.vue

@@ -45,7 +45,7 @@ export default {
 
 <template>
   <gl-link
-    href="https://docs.gitlab.com/ee/user/compliance/compliance_dashboard/#approval-status-and-separation-of-duties"
+    href="https://docs.gitlab.com/ee/user/compliance/compliance_report/#approval-status-and-separation-of-duties"
   >
     <ci-icon v-gl-tooltip.left="tooltip" class="gl-display-flex" :status="{ icon, group }" />
   </gl-link>

ee/config/metrics/counts_7d/20210216183211_compliance_features_track_unique_visits_union.yml

 ---
 data_category: Optional
 key_path: counts_weekly.aggregated_metrics.compliance_features_track_unique_visits_union
-description: 'Unique users that have used audit event screen, audit event API, compliance dashboard, or credential inventory'
+description: 'Unique users that have used audit event screen, audit event API, compliance report, or credential inventory'
 product_section: 'dev'
 product_stage: 'manage'
 product_group: 'group::compliance'

ee/config/metrics/counts_7d/20210216183924_g_compliance_dashboard_weekly.yml

 ---
 data_category: Optional
 key_path: redis_hll_counters.compliance.g_compliance_dashboard_weekly
-description: 'Unique users who have looked at the compliance dashboard in a given week'
+description: 'Unique users who have looked at the compliance report in a given week'
 product_section: 'dev'
 product_stage: 'manage'
 product_group: 'group::compliance'

ee/spec/frontend/compliance_dashboard/components/empty_state_spec.js

@@ -34,7 +34,7 @@ describe('EmptyState component', () => {
 
     it('sets the description', () => {
       expect(emptyStateProp('description')).toBe(
-        'The Compliance Report captures merged changes that violate compliance best practices.',
+        'The compliance report captures merged changes that violate compliance best practices.',
       );
     });
   });

ee/spec/frontend/compliance_dashboard/components/merge_requests/statuses/approval_spec.js

@@ -34,7 +34,7 @@ describe('ApprovalStatus component', () => {
 
     it('links to the approval status', () => {
       expect(findLink().attributes('href')).toEqual(
-        'https://docs.gitlab.com/ee/user/compliance/compliance_dashboard/#approval-status-and-separation-of-duties',
+        'https://docs.gitlab.com/ee/user/compliance/compliance_report/#approval-status-and-separation-of-duties',
       );
     });
 

locale/gitlab.pot

@@ -32443,9 +32443,6 @@ msgstr ""
 msgid "The Advanced Search in GitLab is a powerful search service that saves you time. Instead of creating duplicate code and wasting time, you can now search for code within other teams that can help your own project."
 msgstr ""
 
-msgid "The Compliance Report captures merged changes that violate compliance best practices."
-msgstr ""
-
 msgid "The GitLab subscription service (customers.gitlab.com) is currently experiencing an outage. You can monitor the status and get updates at %{linkStart}status.gitlab.com%{linkEnd}."
 msgstr ""
 
@@ -32512,6 +32509,9 @@ msgstr ""
 msgid "The comparison view may be inaccurate due to merge conflicts."
 msgstr ""
 
+msgid "The compliance report captures merged changes that violate compliance best practices."
+msgstr ""
+
 msgid "The connection will time out after %{timeout}. For repositories that take longer, use a clone/push combination."
 msgstr ""