CSV export for enterprise-level overview (includes GHES CSV export fu…

…nctionality) [GA] (#52747) Co-authored-by: Felix Guntrip <[email protected]> Co-authored-by: Kevin Heis <[email protected]> Co-authored-by: Sarita Iyer <[email protected]>
github · Dec 2, 2024 · 8b8cf6f · 8b8cf6f
1 parent 140fd66
commit 8b8cf6f
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 20 deletions.
diff --git a/content/code-security/security-overview/assessing-adoption-code-security.md b/content/code-security/security-overview/assessing-adoption-code-security.md
@@ -66,7 +66,7 @@ You can view data to assess the enablement of code security features across orga
 In the enterprise-level view, you can view data about the enablement of features, but you cannot enable or disable features.
 {% endif %}
 
-{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
+{% ifversion ghes %}{% data reusables.enterprise-accounts.access-enterprise-ghes %}{% else %}{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}{% endif %}
 {% data reusables.code-scanning.click-code-security-enterprise %}
 1. To display the "Security coverage" view, in the sidebar, click **Coverage**.
 {% data reusables.code-scanning.using-security-overview-coverage %}
@@ -111,7 +111,7 @@ You can view data to assess the enablement status and enablement status trends o
 
 You can view data to assess the enablement status and enablement status trends of code security features across organizations in an enterprise.
 
-{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
+{% ifversion ghes %}{% data reusables.enterprise-accounts.access-enterprise-ghes %}{% else %}{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}{% endif %}
 {% data reusables.code-scanning.click-code-security-enterprise %}
 1. To display the "Enablement trends" view, in the sidebar, click **Enablement trends**.
 1. Click on one of the tabs for "{% data variables.product.prodname_dependabot %}", "{% data variables.product.prodname_code_scanning_caps %}", or "{% data variables.product.prodname_secret_scanning_caps %}" to view enablement trends and the percentage of repositories across organizations in your enterprise with that feature enabled. This data is displayed as a graph and a detailed table.

diff --git a/content/code-security/security-overview/assessing-code-security-risk.md b/content/code-security/security-overview/assessing-code-security-risk.md
@@ -60,15 +60,16 @@ You can view data for security alerts across organizations in an enterprise.
 
 {% data reusables.security-overview.enterprise-filters-tip %}
 
-{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
+{% ifversion ghes %}{% data reusables.enterprise-accounts.access-enterprise-ghes %}{% else %}{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}{% endif %}
 {% data reusables.code-scanning.click-code-security-enterprise %}
 1. To display the "Security risk" view, in the sidebar, click **{% octicon "shield" aria-hidden="true" %} Risk**.
 {% data reusables.code-scanning.using-security-overview-risk %}
 
     ![Screenshot of the "Security risk" view for an enterprise. The options for filtering are outlined in dark orange.](/assets/images/help/security-overview/security-risk-view-highlights-enterprise.png)
 
     {% data reusables.security-overview.unaffected-repositories %}
-{% data reusables.organizations.security-overview-feature-specific-page %}
+{% data reusables.organizations.security-overview-feature-specific-page %}{% ifversion security-overview-export-data %}
+1. Optionally, use the {% octicon "download" aria-hidden="true" %} **Export CSV** button to download a CSV file of the data currently displayed on the page for security research and in-depth data analysis. For more information, see "[AUTOTITLE](/code-security/security-overview/exporting-data-from-security-overview)." {% endif %}
 
 {% data reusables.security-overview.alert-differences %}
 

diff --git a/content/code-security/security-overview/exporting-data-from-security-overview.md b/content/code-security/security-overview/exporting-data-from-security-overview.md
@@ -1,7 +1,7 @@
 ---
 title: Exporting data from security overview
 shortTitle: Export data
-intro: You can export CSV files of your organization's overview, risk, coverage, and {% data variables.product.prodname_codeql %} pull request alerts data from security overview.
+intro: From security overview, you can export CSV files of the data used for your organization or enterprise's overview, risk, coverage, and {% data variables.product.prodname_codeql %} pull request alerts pages.
 permissions: '{% data reusables.permissions.security-overview %}'
 versions:
   feature: security-overview-export-data
@@ -20,14 +20,14 @@ redirect_from:
 
 {% data reusables.security-overview.download-csv-files %}
 
-The overview page contains data about security alerts across your organization, while the risk and coverage pages contain data about repositories and how they are affected by security alerts or covered by security features. The {% data variables.product.prodname_codeql %} pull request alerts page contains data about {% data variables.product.prodname_codeql %} alerts that were caught in pull requests merged to the default branch.
+The overview page contains data about security alerts across your organization or enterprise, while the risk and coverage pages contain data about repositories and how they are affected by security alerts or covered by security features. The {% data variables.product.prodname_codeql %} pull request alerts page contains data about {% data variables.product.prodname_codeql %} alerts that were caught in pull requests merged to the default branch.
 
 The CSV file you download will contain data corresponding to the filters you have applied to security overview. For example, if you add the filter `dependabot-alerts:enabled`, your file will only contain data for repositories that have enabled {% data variables.product.prodname_dependabot_alerts %}.
 
 > [!NOTE]
 > In the "Teams" column of the CSV file, each repository will list a maximum of 20 teams with write access to that repository. If more than 20 teams have write access to a repository, the data will be truncated.
 
-## Exporting data from your organization's security overview
+## Exporting overview, coverage, and risk data from your organization's security overview
 
 {% data reusables.profile.access_org %}
 1. In the "Organizations" section, select the organization for which you would like to download security overview data.
@@ -43,3 +43,12 @@ The CSV file you download will contain data corresponding to the filters you hav
 > The summary views ({% ifversion security-overview-dashboard %}"Overview", {% endif %}"Coverage" and "Risk") show data only for {% ifversion secret-scanning-alert-experimental-list %}default{% else %}high confidence{% endif %} alerts. {% data variables.product.prodname_code_scanning_caps %} alerts from third-party tools, and {% data variables.product.prodname_secret_scanning %} alerts for non-provider patterns or for ignored directories are all omitted from these views. Consequently, files exported from the summary views do not contain data for these types of alert.
 
 {% endif %}
+
+## Exporting overview, coverage, and risk data from your enterprise's security overview
+
+{% ifversion ghes %}{% data reusables.enterprise-accounts.access-enterprise-ghes %}{% else %}{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}{% endif %}
+{% data reusables.code-scanning.click-code-security-enterprise %}
+1. Choose the page that you want to export data from by clicking on **Overview**, **Risk**, or **Coverage**.
+1. Next to the search bar, click {% octicon "download" aria-hidden="true" %} **Export CSV**.
+
+    It may take a moment for {% data variables.product.product_name %} to generate the CSV file of your data. Once the CSV file generates, the file will automatically start downloading, and a banner will appear confirming your report is ready. If you are downloading the CSV from the overview page, you will also receive an email when your report is ready, containing a link to download the CSV.
diff --git a/content/code-security/security-overview/viewing-metrics-for-pull-request-alerts.md b/content/code-security/security-overview/viewing-metrics-for-pull-request-alerts.md
@@ -38,8 +38,6 @@ You can also view:
 
 You can apply filters to the data. The metrics are based on activity from the default period or your selected period.
 
-![Screenshot of the "CodeQL pull request alerts" view for an organization, showing status and trends over 90 days.](/assets/images/help/security-overview/security-overview-codeql-pull-requests-alerts-report.png)
-
 {% ifversion code-scanning-autofix %}
 > [!NOTE] Metrics for {% data variables.product.prodname_copilot_autofix_short %} will be shown only for repositories where {% data variables.product.prodname_copilot_autofix_short %} is enabled.
 {% else %}

diff --git a/...curity/security-overview/viewing-metrics-for-secret-scanning-push-protection.md b/...curity/security-overview/viewing-metrics-for-secret-scanning-push-protection.md
@@ -41,14 +41,10 @@ You can see {% data variables.product.prodname_secret_scanning %} metrics if you
 
 The metrics are based on activity from the default period or your selected period.
 
-![Screenshot of the top section of the "Metrics" view for secret scanning on the "Security" tab for an organization.](/assets/images/help/security-overview/security-overview-secret-scanning-metrics-additional-tools.png)
-
 {% else %}
 
 The metrics are based on activity from the default period or your selected period.
 
-![Screenshot of the top section of the "Metrics" view for secret scanning on the "Security" tab for an organization.](/assets/images/help/security-overview/security-overview-secret-scanning-metrics.png)
-
 {% endif %}
 
 ## Viewing metrics for {% data variables.product.prodname_secret_scanning %} push protection for an organization
@@ -67,7 +63,7 @@ You can view metrics for {% data variables.product.prodname_secret_scanning %} p
 
 {% data reusables.security-overview.enterprise-filters-tip %}
 
-{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
+{% ifversion ghes %}{% data reusables.enterprise-accounts.access-enterprise-ghes %}{% else %}{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}{% endif %}
 {% data reusables.code-scanning.click-code-security-enterprise %}
 1. In the sidebar, click **{% data variables.product.prodname_secret_scanning_caps %} metrics**.
 1. Click on an individual secret type or repository to see the associated {% data variables.secret-scanning.alerts %} for your enterprise.

diff --git a/content/code-security/security-overview/viewing-security-insights.md b/content/code-security/security-overview/viewing-security-insights.md
@@ -49,8 +49,8 @@ The dashboard is divided into three tabs, each focused around a different securi
 
 You can filter the overview dashboard by selecting a specific time period, and apply additional filters to focus on narrower areas of interest. All data and metrics across the dashboard will change as you apply filters. By default, the dashboard displays all alerts from {% data variables.product.prodname_dotcom %} tools, but you can use the tool filter to show alerts from a specific tool ({% data variables.product.prodname_secret_scanning %}, {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, a specific third-party tool) or all third-party {% data variables.product.prodname_code_scanning %} tools. For more information, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)."
 
-{% ifversion security-overview-export-dashboard-data %}
-You can download a CSV file of the overview dashboard data for your organization. This data file can integrate easily with external datasets, so you may find it useful for security research, data analysis, and more. For more information, see "[AUTOTITLE](/code-security/security-overview/exporting-data-from-security-overview)."
+{% ifversion security-overview-export-data %}
+You can download a CSV file of the overview dashboard data for your organization or enterprise. This data file can integrate easily with external datasets, so you may find it useful for security research, data analysis, and more. For more information, see "[AUTOTITLE](/code-security/security-overview/exporting-data-from-security-overview)."
 {% endif %}
 
 {% ifversion security-overview-dashboard-enterprise %}Enterprise members can access the overview page for organizations in their enterprise. {% endif %}The metrics you see will depend on your role and repository permissions. For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview#permission-to-view-data-in-security-overview)."
@@ -75,7 +75,7 @@ Keep in mind that the overview page tracks changes over time for security alert
 
 ## Viewing the security overview dashboard for your enterprise
 
-{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
+{% ifversion ghes %}{% data reusables.enterprise-accounts.access-enterprise-ghes %}{% else %}{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}{% endif %}
 {% data reusables.code-scanning.click-code-security-enterprise %}{% ifversion security-overview-3-tab-dashboard %}
 1. By default, the **Detection** tab is displayed. If you want to switch to another tab to see other metrics, click **Remediation** or **Prevention**.{% endif %}
 {% data reusables.security-overview.filter-and-toggle %}

diff --git a/data/features/security-overview-export-data.yml b/data/features/security-overview-export-data.yml
@@ -1,5 +1,5 @@
-# Reference: #11417
-# Documentation for the ability to download CSV files of data from the risk and coverage pages of security overview.
+# Reference: #11417, #13511, #14353
+# Documentation for the ability to download CSV files of data from the risk and coverage pages of security overview at both org- and enterprise- level.
 versions:
   ghec: '*'
   ghes: '>=3.16'
diff --git a/data/reusables/security-overview/download-csv-files.md b/data/reusables/security-overview/download-csv-files.md
@@ -1 +1 @@
-You can download comma-separated values (CSV) files containing data from the "Overview", "Risk", "Coverage" and "{% data variables.product.prodname_codeql %} pull request alerts" pages of your organization's security overview. These files can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets.
+From security overview, you can download comma-separated values (CSV) files containing data from the "Overview", "Risk", "Coverage" and "{% data variables.product.prodname_codeql %} pull request alerts" pages of your organization{% ifversion security-overview-export-data %} or enterprise{% endif %}'s security overview. These files can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		You can download comma-separated values (CSV) files containing data from the "Overview", "Risk", "Coverage" and "{% data variables.product.prodname_codeql %} pull request alerts" pages of your organization's security overview. These files can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets.
		From security overview, you can download comma-separated values (CSV) files containing data from the "Overview", "Risk", "Coverage" and "{% data variables.product.prodname_codeql %} pull request alerts" pages of your organization{% ifversion security-overview-export-data %} or enterprise{% endif %}'s security overview. These files can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets.