Skip to content

Commit b6d8766

Browse files
authored
Ready to merge - [2022-03-01]: Enterprise-level security overview - [Public Beta] (#25563)
* Make "About the security overview" less specific * Create new sections and adjust headings for ToC * Add info for each level of the security overview * Update reusable w/ public repo sec. overview info * Add procedure for viewing enterprise-level sec overview * Update info about security overview in security features article * Incorporate reviewer feedback (versioning) * Fix enterprise-level overview header * Fix security overview header versioning * fix broken link
1 parent de7bdbf commit b6d8766

File tree

3 files changed

+34
-7
lines changed

3 files changed

+34
-7
lines changed

content/code-security/getting-started/github-security-features.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ The dependency graph allows you to explore the ecosystems and packages that your
6464
You can find the dependency graph on the **Insights** tab for your repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
6565
{% endif %}
6666

67+
### Security overview for repositories
68+
For all public repositories, the security overview shows which security features are enabled for the repository, and offers the option to configure any available security features that are not currently enabled.
69+
6770
## Available with {% data variables.product.prodname_GH_advanced_security %}
6871

6972
{% data reusables.advanced-security.ghas-availability %}
@@ -84,8 +87,8 @@ Automatically detect tokens or credentials that have been checked into a reposit
8487
Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)."
8588
{% endif %}
8689

87-
{% ifversion ghec or ghes > 3.1 %}
88-
### Security overview
90+
{% ifversion ghec or ghes > 3.1 or ghae-issue-4554 %}
91+
### Security overview for organizations{% ifversion ghec or ghes > 3.4 or ghae-issue-6199 %}, enterprises,{% endif %} and teams
8992

9093
Review the security configuration and alerts for your organization and identify the repositories at greatest risk. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."
9194
{% endif %}

content/code-security/security-overview/about-the-security-overview.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,7 @@ shortTitle: About security overview
2626

2727
## About the security overview
2828

29-
You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention.
30-
31-
- At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. You can also filter information per security feature.
32-
- At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)."
33-
- At the repository-level, the security overview shows which security features are enabled for the repository, and offers the option to configure any available security features not currently in use.
29+
You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. You can view aggregate or repository-specific security information in the security overview. You can also use the security overview to see which which security features are enabled for your repositories and to configure any available security features that are not currently in use.
3430

3531
The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %}
3632

@@ -63,3 +59,24 @@ For each repository in the security overview, you will see icons for each type o
6359
| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. |
6460

6561
The security overview displays active alerts raised by security features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist.
62+
63+
### About the organization-level security overview
64+
65+
At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. You can filter information by security features at the organization-level.
66+
67+
{% ifversion ghec or ghes > 3.4 or ghae-issue-6199 %}
68+
### About the enterprise-level security overview
69+
At the enterprise-level, the security overview displays aggregate and repository-specific security information for your enterprise. You can view repositories owned by your enterprise that have security alerts or view all {% data variables.product.prodname_secret_scanning %} alerts from across your enterprise.
70+
71+
Organization owners and security managers for organizations in your enterprise also have limited access to the enterprise-level security overview. They can only view repositories and alerts for the organizations that they have full access to.
72+
73+
{% elsif fpt %}
74+
### About the enterprise-level security overview
75+
At the enterprise-level, the security overview displays aggregate and repository-specific information for an enterprise. For more information, see "[About the enterprise-level security overview](/enterprise-cloud@latest/code-security/security-overview/about-the-security-overview#about-the-enterprise-level-security-overview)" in the {% data variables.product.prodname_ghe_cloud %} documentation.
76+
{% endif %}
77+
78+
### About the team-level security overview
79+
At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)."
80+
81+
### About the repository-level security overview
82+
At the repository-level, the security overview shows which security features are enabled for the repository, and offers the option to configure any available security features that are not currently enabled.

content/code-security/security-overview/viewing-the-security-overview.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@ shortTitle: View the security overview
4040
2. Optionally, filter the list of alerts. Each view has its own selection of available filters. You can click multiple filters in the drop-down filter menus to narrow your search. You can also type search qualifiers in the search 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)."
4141
![The drop-down filter menus and Search repositories field in the secret scanning view](/assets/images/help/organizations/secret-scanning-filter-alerts.png)
4242

43+
{% ifversion ghec or ghes > 3.4 or ghae-issue-6199 %}
44+
## Viewing the security overview for an enterprise
45+
46+
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
47+
1. In the left sidebar, click {% octicon "shield" aria-label="The shield icon" %} **Security**.
48+
{% endif %}
49+
4350
## Viewing alerts for a repository
4451

4552
{% data reusables.repositories.navigate-to-repo %}

0 commit comments

Comments
 (0)