-
Notifications
You must be signed in to change notification settings - Fork 60.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add content for "Security overview CSV export" (#41269)
Co-authored-by: Kelly Arwine <[email protected]> Co-authored-by: SiaraMist <[email protected]>
- Loading branch information
1 parent
a56a8b6
commit eda3c5e
Showing
8 changed files
with
59 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
...e-security/security-overview/exporting-data-from-the-risk-and-coverage-pages.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Exporting data from the risk and coverage pages | ||
shortTitle: Export data | ||
intro: You can export CSV files of your risk and coverage data from security overview. | ||
permissions: '{% data reusables.security-overview.permissions %}' | ||
product: '{% data reusables.gated-features.security-overview %}' | ||
versions: | ||
feature: security-overview-export-data | ||
type: how_to | ||
topics: | ||
- Security overview | ||
- Advanced Security | ||
- Alerts | ||
- Organizations | ||
- Teams | ||
--- | ||
|
||
## About exporting your risk and coverage data | ||
|
||
{% data reusables.security-overview.download-csv-files %} | ||
|
||
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 %} | ||
|
||
**Note:** You can only export data for the first 20 teams in your organization. These 20 teams correspond with the first 20 teams visible in the **Teams** {% octicon "triangle-down" aria-hidden="true" %} dropdown menu on security overview. | ||
|
||
{% endnote %} | ||
|
||
## Exporting risk or coverage 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 risk and/or coverage data. | ||
{% data reusables.organizations.security-overview %} By default, you will see the risk page of your organization's security overview. | ||
1. If you would instead like to download coverage data for your organization, in the "Security" sidebar, click {% octicon "meter" aria-hidden="true" %} **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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Reference: #11417 | ||
# Documentation for the ability to download CSV files of data from the risk and coverage pages of security overview. | ||
versions: | ||
ghec: '*' | ||
ghes: '>3.11' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your organizations**. | ||
1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click{% ifversion fpt or ghec %} {% octicon "organization" aria-hidden="true" %}{% endif %} **Your organizations**. | ||
|
||
![Screenshot of the dropdown menu under @octocat's profile picture. "Your organizations" is outlined in dark orange.](/assets/images/help/profile/your-organizations.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
You can download CSV files containing data from the risk and coverage pages of security overview. These files can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets. |