aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs
diff options
context:
space:
mode:
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>2021-08-10 14:55:50 -0500
committersonartech <sonartech@sonarsource.com>2021-08-12 20:07:59 +0000
commit5589d0e0da0168d6d4af8ac4611f2dfc63c1687f (patch)
tree0c97b58a2873c75925105338fb2101ee0c44f15d /server/sonar-docs
parentdafc7f30715e9d061e8b2c5b6d178ed2f6775ffd (diff)
downloadsonarqube-5589d0e0da0168d6d4af8ac4611f2dfc63c1687f.tar.gz
sonarqube-5589d0e0da0168d6d4af8ac4611f2dfc63c1687f.zip
SONAR-15140 add PDF report subscription info
Diffstat (limited to 'server/sonar-docs')
-rw-r--r--server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md36
1 files changed, 27 insertions, 9 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 854cda6cf43..5999187ec80 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,31 +1,49 @@
---
-title: PDF Report Configuration
+title: PDF Reports
url: /project-administration/portfolio-pdf-configuration/
---
*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/).*
-PDF reports give a periodic, high-level overview on the overall code quality and security of your projects, applications, or portfolios.
+PDF reports give a periodic, high-level overview of the overall code quality and security of your projects, applications, or portfolios.
## 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.
+Users with access to a project or application can download a PDF report or subscribe to receive PDF reports from the **Project/Application PDF Report** drop-down menu in the upper-right corner of the project or application's home page. The frequency that you receive reports is set by a project or application administrator.
+
+### Changing PDF subscription frequency
+Users with administrative rights on a project or application can configure how frequently SonarQube sends PDF reports. You can change the frequency all projects and applications at a global level or for each project or application individually:
+
+- **Global-level** – To change the frequency setting globally, navigate to **Administration > General Settings > Governance**. Under **Project and Application PDF Reports**, select an option from the **PDF Reports Frequency** drop-down menu.
+
+- **Project-level** – To change the frequency setting for a specific project, navigate to the project's home page then **Project Settings > General Settings > Governance**. Under **Project and Application PDF Reports**, select an option from the **PDF Reports Frequency** drop-down menu.
+
+- **Application-level** – To change the frequency setting for a specific application, navigate to the application's home page then **Application Settings > Application Report Settings**, and select an option from the **Application Reports Frequency** drop-down menu.
+
+You have the following options for subscription frequency:
+
+- **Daily** – report is sent on a daily basis.
+- **Weekly** – report is sent on a weekly basis.
+- **Monthly (default)** – report is sent on a monthly basis.
+
+### Temporary branches
+You cannot download or subscribe to a PDF report for a temporary branch. If you are unable to download or subscribe to a PDF report for a branch, go to **Project Settings > Branches & Pull Requests** and make sure that the **Keep when inactive** toggle is on for that branch.
## 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.
+Users with administrative rights on a portfolio can configure how frequently SonarQube sends PDF reports. You can change the frequency for all portfolios globally 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.
+- **Global-level** – 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**.
+- **Portfolio-level** – To change the frequency setting for a specific portfolio, navigate to the portfolio's 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
+- **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
### 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