[Accessibility] Revise images for security overview (#34674)
Co-authored-by: Laura Coursen <lecoursen@github.com>
До Ширина: | Высота: | Размер: 148 KiB После Ширина: | Высота: | Размер: 216 KiB |
Двоичные данные
assets/images/help/security-overview/security-coverage-view.png
До Ширина: | Высота: | Размер: 118 KiB |
Двоичные данные
assets/images/help/security-overview/security-overview-icons.png
До Ширина: | Высота: | Размер: 6.1 KiB |
До Ширина: | Высота: | Размер: 27 KiB |
До Ширина: | Высота: | Размер: 136 KiB После Ширина: | Высота: | Размер: 183 KiB |
Двоичные данные
assets/images/help/security-overview/security-risk-view.png
До Ширина: | Высота: | Размер: 93 KiB |
|
@ -64,41 +64,33 @@ The application security team at your company can use the different views for bo
|
|||
|
||||
Organization owners and security managers for organizations have access to the security overview for their organizations. {% ifversion ghec or ghes > 3.6 or ghae > 3.6 %}Organization members can also access the organization-level security overview to view results for repositories where they have admin privileges or have been granted access to security alerts. For more information on managing security alert access, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %}
|
||||
|
||||
{% ifversion security-overview-single-repo-enablement or security-overview-org-risk-coverage %}
|
||||
{% ifversion security-overview-org-risk-coverage %}
|
||||
|
||||
### Security Risk view
|
||||
|
||||
This view shows data about the repositories affected by different types of security alert.
|
||||
|
||||
- Use the **Type** and **Teams** drop-downs to add repository type and team filters.
|
||||
- Click **Open alerts** or **Repositories affected** to show only repositories with a specific type of security alert.
|
||||
- Use the **Teams** dropdown menu to show information only for the repositories owned by one or more teams.
|
||||
- Click **NUMBER affected** or **NUMBER unaffected** in the header for any type of alert to show only the repositories with or without alerts of that type.
|
||||
- Click any of the descriptions of "Open alerts" in the header to show only repositories with alerts of that type and category. For example, **1 critical** to show the repository with a critical alert for {% data variables.product.prodname_dependabot %}.
|
||||
- Click **NUMBER Archived** to show only repositories that are archived.
|
||||
- Click in the search box to show a list of the full set of available filters.
|
||||
|
||||
In addition, when you click in the search box, a list of the full set of filters available is shown.
|
||||
|
||||
![Screenshot of the Security Risk view for an organization](/assets/images/help/security-overview/security-risk-view.png)
|
||||
![Screenshot of the "Security Risk" view on the "Security" tab for an organization. Illustrates information and filter options available in the view.](/assets/images/help/security-overview/security-risk-interactive-header.png)
|
||||
|
||||
|
||||
### Security Coverage view
|
||||
|
||||
This view shows data about which repositories are using security features.
|
||||
This view shows data about which security features are used by repositories in the organization. You can filter the view to show the repositories of interest using links, a dropdown menu, and a search field.
|
||||
|
||||
- Use the **Type** and **Teams** drop-downs to add repository type and team filters.
|
||||
- Click **Alerts enabled** and other features listed in the header to see only repositories with those features enabled.
|
||||
- Change any `FEATURE:enabled` filter to `FEATURE:not-enabled` in the search box to see repositories that haven't enabled a feature.
|
||||
{%- ifversion security-overview-single-repo-enablement %}
|
||||
- For any repository, click **Security Settings** to enable security features that have a one-click setup.
|
||||
- Use the **Teams** dropdown to show information only for the repositories owned by one or more teams.
|
||||
- Click **NUMBER enabled** or **NUMBER not enabled** in the header for any feature to show only the repositories with that feature enabled or not enabled.
|
||||
- Click **NUMBER Archived** to show only repositories that are archived.
|
||||
- Click in the search box to show a list of the full set of available filters.
|
||||
|
||||
In addition, when you click in the search box, a list of the full set of filters available is shown.
|
||||
In addition, you can click **{% octicon "gear" aria-label="" %} Security settings** for any repository to enable the security features that have a one-click setup.
|
||||
|
||||
![Screenshot of the Security Coverage view for an organization](/assets/images/help/security-overview/security-coverage-view-single-repo-enablement.png)
|
||||
|
||||
{%- elsif security-overview-org-risk-coverage %}
|
||||
- For any repository, click the ellipsis (**...**) then **Security Settings** to enable additional features.
|
||||
|
||||
In addition, when you click in the search box, a list of the full set of filters available is shown.
|
||||
|
||||
![Screenshot of the Security Coverage view for an organization](/assets/images/help/security-overview/security-coverage-view.png)
|
||||
{% endif %}
|
||||
![Screenshot of the "Security Coverage" view on the "Security" tab for an organization. Illustrates information and filter options available in view.](/assets/images/help/security-overview/security-coverage-view-single-repo-enablement.png)
|
||||
|
||||
{% else %}
|
||||
|
||||
|
@ -108,8 +100,6 @@ In addition, when you click in the search box, a list of the full set of filters
|
|||
|
||||
For each repository in the security overview, you will see icons for each type of security feature and how many alerts there are of each type. If a security feature is not enabled for a repository, the icon for that feature will be grayed out. In addition, a risk score is calculated for each repository based on its code scanning, Dependabot and secret scanning alerts. This score is in beta and should be used with caution. Its algorithm and approach is subject to change.
|
||||
|
||||
![Icons in the security overview](/assets/images/help/security-overview/security-overview-icons.png)
|
||||
|
||||
| Icon | Meaning |
|
||||
| -------- | -------- |
|
||||
| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." |
|
||||
|
|
|
@ -31,21 +31,21 @@ shortTitle: View the security overview
|
|||
{% ifversion security-overview-org-risk-coverage %}
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.security-overview %}
|
||||
1. Choose the overview you want to display from the options in the sidebar.
|
||||
1. Use the drop-down filters and search box to focus on the information of greatest interest. The "Security Risk" and "Security Coverage" views also have an interactive header that you can use to filter results.
|
||||
|
||||
![Screenshot of the Security Risk view with interactive header highlighted](/assets/images/help/security-overview/security-risk-interactive-header.png)
|
||||
1. To display a summary view, in the sidebar, click **{% octicon "shield" %} Risk** or **{% octicon "meter" %} Coverage**.
|
||||
1. Optionally, to focus on the information of greatest interest, select the **Teams** dropdown filter and search box.
|
||||
1. Optionally, use links in the "{% data variables.product.prodname_dependabot %}", "{% data variables.product.prodname_code_scanning %}", and "{% data variables.product.prodname_secret_scanning %}" header summaries to filter results further.
|
||||
![Screenshot of the "Security Risk" view on the "Security" tab for an organization. Illustrates information and filter options available in the view.](/assets/images/help/security-overview/security-risk-interactive-header.png)
|
||||
{% data reusables.organizations.security-overview-feature-specific-page %}
|
||||
|
||||
{% else %}
|
||||
|
||||
{% data reusables.organizations.navigate-to-org %}
|
||||
{% data reusables.organizations.security-overview %}
|
||||
1. To view aggregate information about alert types, click **Show more**.
|
||||
![Show more button](/assets/images/help/security-overview/security-overview-show-more-button.png)
|
||||
{% data reusables.organizations.filter-security-overview %}
|
||||
{% ifversion security-overview-alert-views %}
|
||||
{% data reusables.organizations.security-overview-feature-specific-page %}
|
||||
![Screenshot of the code scanning-specific page](/assets/images/help/security-overview/security-overview-code-scanning-alerts.png)
|
||||
![Screenshot of the {% data variables.product.prodname_code_scanning %} alerts page on the "Security" tab. Features apart from filters, dropdown menus, and sidebar are grayed out.](/assets/images/help/security-overview/security-overview-code-scanning-alerts.png)
|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
@ -57,7 +57,7 @@ shortTitle: View the security overview
|
|||
{% data reusables.security-overview.security-coverage-single-repo-enablement %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
|
||||
1. In the left sidebar, click {% octicon "shield" aria-label="The shield icon" %} **Code Security**.
|
||||
1. In the left sidebar, click **{% octicon "shield" aria-label="" %} Code Security**.
|
||||
{% ifversion security-overview-feature-specific-alert-page %}
|
||||
{% data reusables.organizations.security-overview-feature-specific-page %}
|
||||
{% endif %}
|
||||
|
|
|
@ -1,5 +1,7 @@
|
|||
# Reference: #8557.
|
||||
# Reference: #8557 and #8765.
|
||||
# Documentation for the organization-level split of the "Overview" page into "Risks" and "Coverage"
|
||||
# and the initial single-repo enablement panel for security overview coverage view.
|
||||
versions:
|
||||
ghes: '> 3.7'
|
||||
ghae: '> 3.7'
|
||||
ghec: '*'
|
||||
|
|
|
@ -1,6 +0,0 @@
|
|||
# Reference: #8765.
|
||||
# Documentation for the single-repo enablement panel for security overview coverage view
|
||||
versions:
|
||||
ghes: '> 3.7'
|
||||
ghae: '> 3.7'
|
||||
ghec: '*'
|
|
@ -1,2 +1,2 @@
|
|||
1. Optionally, filter the list of alerts. You can click multiple filters in the drop-down filter menus to narrow your search. You can also type search qualifiers in the **Search repositories** field. For more information about the available qualifiers, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)."
|
||||
![The drop-down filter menus and Search repositories field in the security overview](/assets/images/help/security-overview/security-overview-filter-alerts.png)
|
||||
![Screenshot showing the dropdown filter menus and "Search repositories" field in the security overview.](/assets/images/help/security-overview/security-overview-filter-alerts.png)
|
||||
|
|
|
@ -1 +1 @@
|
|||
1. Alternatively and optionally, use the sidebar on the left to filter information per security feature. On each page, you can use filters that are specific to that feature to fine-tune your search. For more information about the available qualifiers, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)."
|
||||
1. Optionally, use the sidebar on the left to explore alerts for a specific security feature in greater detail. On each page, you can use filters that are specific to that feature to fine-tune your search. For more information about the available qualifiers, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)."
|
||||
|
|