Skip to content

Compliance framework report pagination + docs + copy changes

Elwyn Benson requested to merge 387910-compliance-framework-report-docs into master

What does this MR do and why?

Continues implementation of new Compliance Framework Report from Draft: Basic compliance Framework Report data f... (!110855 - closed)

Note this new report is still behind a development feature flag, but should be ready to release once this MR is merged.

Add pagination to the new report table. Allow going forward/back pages, and allow selecting a page size.


Tweak the language slightly within the app to reflect the new report as per previous MR reviewer feedback.


This is the last functionality required before the feature could be not broken / useful to customers, so also update documentation.

This is the documentation page being adjusted: https://docs.gitlab.com/ee/user/compliance/compliance_report/

I have renamed occurrences of compliance report to compliance violations report so as to differentiate the existing / new reports.

As part of these new docs I have tweaked the hierarchy of all headings on the page, so that compliance violations report and compliance framework report are at equal level, and all relevant sub-topics are nested.

Note that I have not mentioned filtering/searching here, as I assume we will wish to release the feature (+these docs) without that functionality being completed yet.

Screenshots or screen recordings

compliance-report-pagination

image

How to set up and validate locally

New documentation can be viewed locally here: http://gdk.test:3005/ee/user/compliance/compliance_report/

(You will need to have gdk configured to run the docs)

For the feature:

  1. Be on GitLab Ultimate
  2. Browse to a Group (you must be Owner) -> Security & Compliance -> Compliance Report -> Frameworks tab
  3. It should load 20 projects (if the group has that many) and show Prev / Next
  4. Selecting page size should re-fetch data with the new page size
  5. If all results fit on one page, pagination will be hidden
  6. Updated copy is above the tabs
Feature.enable(:compliance_frameworks_report)
Feature.disable(:compliance_frameworks_report)

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #387910 (closed)

Edited by Elwyn Benson

Merge request reports