aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs/src
diff options
context:
space:
mode:
authorPeeter Piegaze <peeter@MAC0174.local>2022-05-12 14:06:26 +0200
committersonartech <sonartech@sonarsource.com>2022-05-25 20:03:16 +0000
commitfed22c35544119dbbce6bad4166f2d023d148652 (patch)
tree011cb58064ab86c2db21742c9a23e87174d01e1f /server/sonar-docs/src
parentc1a02f45496281a6a6ad7ab937531cc6004d9ca5 (diff)
downloadsonarqube-fed22c35544119dbbce6bad4166f2d023d148652.tar.gz
sonarqube-fed22c35544119dbbce6bad4166f2d023d148652.zip
SONAR-16316 Update the sonarqube docs to inform users of how to download a regulatory report
Diffstat (limited to 'server/sonar-docs/src')
-rw-r--r--server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md b/server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md
index 5999187ec80..10debc89626 100644
--- a/server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md
+++ b/server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md
@@ -46,4 +46,19 @@ You have the following options for subscription frequency:
- **Monthly (default)** – report is sent during the first portfolio calculation of the month (if any), starting from the first day of the current month
### Sending portfolio PDF reports to non-SonarQube users
-Users with administrative rights on a portfolio can send the portfolio PDF report to non-SonarQube users by adding their email in the **Other Recipients** field at **Portfolio Settings > Executive Report**. \ No newline at end of file
+Users with administrative rights on a portfolio can send the portfolio PDF report to non-SonarQube users by adding their email in the **Other Recipients** field at **Portfolio Settings > Executive Report**.
+
+## Regulatory PDF Reports
+
+Users with access to a project can download a regulatory report for any permanent branch of that project.
+A permanent branch is one that has been set to **Keep when inactive** (see [Branch Analysis](/branches/overview/) for details on how to adjust this setting).
+
+To download the regulatory report, go to **Project Information > Regulatory Report** and select the desired branch.
+The report will be dynamically generated and downloaded.
+This may take a few minutes.
+
+The report is a zip file containing a snapshot of the selected branch. It contains:
+
+* An overview of the the selected branch of the project.
+* The configuration items relevant to the project's quality (quality profile, quality gate, and analysis exclusions).
+* Lists of findings for both new and overall code on the selected branch.