aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs
diff options
context:
space:
mode:
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>2021-08-03 16:00:51 -0500
committersonartech <sonartech@sonarsource.com>2021-08-09 20:03:18 +0000
commit3372d6349cec60937f6afdbf05c7c275fa24d16d (patch)
tree2d18e7a21166b4993ebf53501cce460c85cb4359 /server/sonar-docs
parent215c107d7f79fe008030689c4556a34347d0072e (diff)
downloadsonarqube-3372d6349cec60937f6afdbf05c7c275fa24d16d.tar.gz
sonarqube-3372d6349cec60937f6afdbf05c7c275fa24d16d.zip
SONAR-15140 Add info on downloading project reports
Diffstat (limited to 'server/sonar-docs')
-rw-r--r--server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md27
1 files changed, 20 insertions, 7 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 2a5315dc1d4..854cda6cf43 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
@@ -1,18 +1,31 @@
---
-title: Portfolio PDF Configuration
+title: PDF Report Configuration
url: /project-administration/portfolio-pdf-configuration/
---
-*Portfolio PDFs are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).*
+*PDF Reports are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).*
-A user with administrative rights on a portfolio can configure email distribution of the PDF. From a Portfolio Home Page go to **Administration > Executive Report**.
+PDF reports give a periodic, high-level overview on the overall code quality and security of your projects, applications, or portfolios.
-### Frequency
-You can tune the email frequency of the PDF Report. The possible values are:
+## Project and Application PDF Reports
+
+Users with access to a project or application can download a PDF reportfrom the **Project PDF Report** drop-down menu in the upper-right corner of the project or application's home page.
+
+## Portfolio PDF Reports
+Users with access to a portfolio can download a PDF report or subscribe to receive PDF reports from the **Portfolio PDF Report** drop-down menu in the upper-right corner of the portfolio's home page. The frequency that you receive reports is set by a portfolio administrator. See the following section for more information.
+
+### Changing PDF subscription frequency
+Users with administrative rights on a portfolio can configure the frequency at which the PDF is sent. You can change the frequency globally for all portfolios or for each portfolio individually.
+
+To change the frequency setting at a global level, navigate to **Administration > Portfolios**, and select an option from the **Frequency** drop-down menu.
+
+To change the frequency setting at a portfolio level, navigate to a portfolio home page then **Portfolio Settings > Executive Report** and select an option under **Frequency**.
+
+You have the following options for subscription frequency:
* Daily: report is sent during the first portfolio calculation of the day (if any)
* Weekly: report is sent during the first portfolio calculation of the week (if any) from Monday
* Monthly (default): report is sent during the first portfolio calculation of the month (if any), starting from the first day of the current month
-### Other Recipients
-If people without SonarQube accounts want to receive the PDF, you can feed the administrative "Other Recipients" field with their email addresses.
+### 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