Skip to content
GitLab Next
Closed
Created by Austin Regnery@aregneryDeveloper

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

Problem to solve

The current Compliance Dashboard does not use any data visualization components, and is better defined as a Compliance Report. Recently, devopssecure separated the Vulnerability Report from the Security Dashboard for the same reason.

Documentation and Handbook References

Grep results

Ignore code declarations (e.g. usage ping metrics name)

grep -ri "Compliance[ _-]dashboard" ./doc
./doc/development/export_csv.md:| 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) |
./doc/development/usage_ping/dictionary.md:### `compliance_unique_visits.g_compliance_dashboard`
./doc/development/usage_ping/dictionary.md:Number of unique visitors to the compliance dashboard.
./doc/development/usage_ping/dictionary.md:[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210216183904_g_compliance_dashboard.yml)
./doc/development/usage_ping/dictionary.md:Unique users that have used audit event screen, audit event API, compliance dashboard, or credential inventory
./doc/development/usage_ping/dictionary.md:Unique users that have used audit event screen, audit event API, compliance dashboard, or credential inventory
./doc/development/usage_ping/dictionary.md:### `redis_hll_counters.compliance.g_compliance_dashboard_monthly`
./doc/development/usage_ping/dictionary.md:Unique users who have viewed the compliance dashboard in a given month.
./doc/development/usage_ping/dictionary.md:[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210216183926_g_compliance_dashboard_monthly.yml)
./doc/development/usage_ping/dictionary.md:### `redis_hll_counters.compliance.g_compliance_dashboard_weekly`
./doc/development/usage_ping/dictionary.md:Unique users who have looked at the compliance dashboard in a given week
./doc/development/usage_ping/dictionary.md:[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210216183924_g_compliance_dashboard_weekly.yml)
./doc/development/usage_ping/index.md:    {"users_viewing_compliance_dashboard_weekly"=>0,
./doc/development/usage_ping/index.md:     "users_viewing_compliance_dashboard_monthly"=>0,
./doc/user/compliance/compliance_dashboard/index.md:# Compliance Dashboard **(ULTIMATE)**
./doc/user/compliance/compliance_dashboard/index.md:The Compliance Dashboard gives you the ability to see a group's merge request activity
./doc/user/compliance/compliance_dashboard/index.md:To access the Compliance Dashboard for a group, navigate to **{shield}** **Security & Compliance > Compliance** on the group's menu.
./doc/user/compliance/compliance_dashboard/index.md:![Compliance Dashboard](img/compliance_dashboard_v13_11.png)
./doc/user/compliance/compliance_dashboard/index.md:The Compliance Dashboard shows only the latest MR on each project.
./doc/user/compliance/compliance_dashboard/index.md:If you do not see the success icon in your Compliance dashboard; please review the above criteria for the merge requests
./doc/user/compliance/compliance_dashboard/index.md:the dropdown next to the **List of all merge commits** button at the top of the Compliance Dashboard.
./doc/user/compliance/compliance_dashboard/index.md:Feature.enable(:compliance_dashboard_drawer)
./doc/user/compliance/compliance_dashboard/index.md:Feature.enable(:compliance_dashboard_drawer, Group.find(<group id>))
./doc/user/compliance/compliance_dashboard/index.md:Feature.disable(:compliance_dashboard_drawer)
./doc/user/compliance/compliance_dashboard/index.md:Feature.disable(:compliance_dashboard_drawer, Group.find(<group id>)
./doc/user/compliance/index.md:- [Compliance Dashboard](compliance_dashboard/index.md): View recent merge request activity across
./doc/user/project/merge_requests/approvals/settings.md:- [Compliance Dashboard](../../../compliance/compliance_dashboard/index.md)
./doc/administration/compliance.md:|**[Compliance dashboard](../user/compliance/compliance_dashboard/index.md)**<br>Quickly get visibility into the compliance posture of your organization. | Ultimate | **{check-circle}** Yes | Group |

Implementation plan

frontend - 2️⃣

  • Copy doc/user/compliance/compliance_dashboard/* docs to doc/user/compliance/compliance_report/* and add a redirect for each doc within the old folder
  • Update documentation links and text to use [Cc]compliance[ -_]report
  • Update ee/app/assets/javascripts/compliance_dashboard/components/empty_state.vue:23 with the new path
  • Update ee/app/assets/javascripts/compliance_dashboard/components/merge_requests/statuses/approval.vue:48 with the new path
  • Update ee/spec/frontend/compliance_dashboard/components/merge_requests/statuses/approval_spec.js:37 with the new path
Edited by Robert Hunt