Skip to content

Commit 49eb292

Browse files
feat: update documentation for new srm findings page (#2321)
* update documentation for new srm findings page * Update docs/organizations/managing-security-and-risk.md Co-authored-by: Cláudia <[email protected]> --------- Co-authored-by: Cláudia <[email protected]>
1 parent fb91783 commit 49eb292

7 files changed

+7
-7
lines changed
333 KB
Loading
-147 KB
Loading
-323 KB
Loading
125 KB
Loading
152 KB
Loading
277 KB
Loading

docs/organizations/managing-security-and-risk.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,18 +88,18 @@ To access the findings page with the corresponding filter applied, click on a ca
8888

8989
## Findings {: id="item-list"}
9090

91-
The **Security and risk management findings** page displays a filtered list of findings. By default, this list is sorted by status, and you can click the **First detected** column name to sort the findings by the detection date. Use this page to review and prioritize findings and track the progress of your security efforts.
91+
The **Security and risk management findings** page displays a filtered list of findings. By default, you are shown the findings that are currently opened and this list is sorted by **Latest findings** found. You can click on the sort dropdown to sort the findings by detection date - latest or oldest. Use this page to review and prioritize findings and track the progress of your security efforts.
9292

9393
To access the findings page, access the [overview page](#dashboard) and click the **Findings** tab.
9494

9595
![Security and risk management findings page](images/security-risk-management-findings.png)
9696

97-
When viewing the findings, you can update the filtering criteria by clicking the [**Segments**](../segments) , **Repository**, **Severity**, **Status**, **Security category**, or **Scan type** drop-downs above the list.
97+
On the left section of the page, besides sorting, you can update the filtering criteria by clicking the [**Segments**](../segments) , **Repositories**, **Severities**, **Statuses**, **Security categories**, or **Scan types** dropdowns above the list.
9898
!!! info "Check out how to [enable and configure **Segments**](../segments/#enabling-segments)"
9999

100-
The **Details** column offers a quick overview of each finding in the list, including its title, [source platform](#opening-and-closing-items), [scan type](#scan-types), [security category](#supported-security-categories), and related information such as the repository name, Jira issue key, or penetration testing report URL. To find out more, click this overview to navigate to the finding details on the source platform.
100+
On the right section, you can view the filtered list of findings. Each finding card offers a quick overview of the vulnerability found, including its title, [source platform](#opening-and-closing-items), [scan type](#scan-types), [security category](#supported-security-categories), and related information such as the repository name, Jira issue key, or affected URL targets. To find out more, click this overview to navigate to the finding details on the source platform.
101101

102-
![Security and risk management finding details](images/security-risk-management-finding-details.png)
102+
![Security and risk management finding page](images/security-risk-management-finding-details.png)
103103

104104
## Sharing a filtered view of findings {: id="sharing-filtered-view"}
105105

@@ -111,7 +111,7 @@ To share the current view of the overview or findings page, click the **Copy URL
111111

112112
!!! info "This feature is available only to organization admins and organization managers except for findings detected on [Git repositories](#opening-and-closing-items). For those findings, [repository permissions are respected](../repositories/issues.md#ignoring-and-managing-issues)"
113113

114-
On the finding's details page, you can ignore a finding using the context menu. When ignoring a finding you can optionally specify a reason for doing so.
114+
You can ignore a finding using the context menu both in the findings list page and the findings details page. When ignoring a finding you can optionally specify a reason for doing so.
115115

116116
![Security and risk management finding ignore](images/security-risk-management-finding-ignore.png)
117117

@@ -123,11 +123,11 @@ From Codacy's standpoint, ignoring a finding means it will be removed from the m
123123

124124
!!! Important "Ignoring findings detected on [Git repositories](#opening-and-closing-items) will also [ignore the issue at the repository level](../repositories/issues.md#ignoring-and-managing-issues)."
125125

126-
You can still see **Ignored** findings in the [findings list](#item-list), by filtering for the **Ignored** status in the **Status** dropdown. Check the **Status** column to know the status of a finding.
126+
You can still see **Ignored** findings in the [findings list](#item-list), by filtering for the **Ignored** status in the **Statuses** dropdown. You can assess which status a finding has at his overview, on the right top corner.
127127

128128
![Security and risk management finding unignore list](images/security-risk-management-finding-unignore-list.png)
129129

130-
An Ignored finding can be **unignored** directly from the [findings list](#item-list) or by going to the same menu where the ignore action was performed, in the findings details page. Note that in this page you can also find out more about who ignored the finding and why, if such a reason was provided.
130+
An Ignored finding can be **unignored** directly from the [findings list](#item-list) or by going to the same menu in the finding details page. Note that in this page you can also find out more about who ignored the finding and why, if such a reason was provided.
131131

132132
Unignoring a finding reverts the effects of ignoring it.
133133

0 commit comments

Comments
 (0)