feature: Document ignore security findings feature [TAROT-2883]

codacy · Oct 23, 2024 · fa95333 · fa95333
1 parent 307fcd7
commit fa95333
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 0 deletions.
diff --git a/docs/organizations/audit-logs-for-organizations.md b/docs/organizations/audit-logs-for-organizations.md
@@ -80,3 +80,10 @@ The sections below list the events that Codacy logs for your organization at use
 | Update quality settings for repository                                                                               | Update quality settings for repository                       |`repositories.settings.quality.repository.update`|
 | Update quality settings for pull requests                                                                            | Update quality settings for pull requests                    |`repositories.settings.quality.pullrequests.update`|
 | Update file state                                                                                                    | Ignore or Unignore file                                      |`repositories.file.update`|
+
+### Security and Risk Management
+
+|Event|Description|Action|
+|-----|-----------|------|
+|Ignore security finding|Security finding was ignored|`srm.finding.ignore`|
+|Unignore security finding|Security finding was unignored|`srm.finding.unignore`|
diff --git a/docs/organizations/images/security-risk-management-finding-ignore.png b/docs/organizations/images/security-risk-management-finding-ignore.png
diff --git a/docs/organizations/images/security-risk-management-finding-unignore-list.png b/docs/organizations/images/security-risk-management-finding-unignore-list.png
diff --git a/docs/organizations/images/security-risk-management-finding-unignore.png b/docs/organizations/images/security-risk-management-finding-unignore.png
diff --git a/docs/organizations/managing-security-and-risk.md b/docs/organizations/managing-security-and-risk.md
@@ -106,6 +106,36 @@ To share the current view of the overview or findings page, click the **Copy URL
 
 !!! Important " [**Segments**](../segments) filter won't be considered when sharing the filtered view"
 
+## Ignoring findings {: id="ignoring-findings"}
+
+!!! info "This feature is available only to organization admins and organization managers"
+
+In the findings details page, it is possible to ignore it using the context menu. When ignoring an issue you can optionally specify a reason for doing so.
+
+![Security and risk management finding ignore](images/security-risk-management-finding-ignore.png)
+
+From an organization standpoint, ignoring a finding means that you accept the risk it poses and you're not planning on adressing the issue.
+
+From Codacy's standpoint, ignoring a finding means it will be removed from the metrics featured in the [overview page](#dashboard) page. Note that the [Open Findings history](#open-findings-history) chart will only be changed at the start of next week.
+
+!!! info [Jira](./integrations/jira-integration.md) findings can't be ignored in Codacy. You should closed the issue directly in Jira.
+
+!!! warn Ignoring findings detected on [Git repositories](#how-codacy-manages-findings-detected-on-git-repositories--idopening-and-closing-codacy-items) will also [ignore the issue at the repository level](../repositories/issues.md#ignoring-and-managing-issues).
+
+You can still see **Ignored** findings in the [findings list](#findings--iditem-list), by filtering for the **Ignored** status in the **Status** dropdown. Check the **Status** column to know the status of a finding.
+
+![Security and risk management finding unignore list](images/security-risk-management-finding-unignore-list.png)
+
+An Ignored finding can be **unignored** directly from the [findings list](#findings--iditem-list) or by going to the same menu where the ignore action was performed, in the findings details page. Note that in this panel you can also find out more about who ignored the issue and why, if such a reason was provided.
+
+Unignoring a finding reverts the effects of ignoring it.
+
+![Security and risk management finding unignore](images/security-risk-management-finding-unignore.png)
+
+!!! warn Unignoring findings detected on [Git repositories](#how-codacy-manages-findings-detected-on-git-repositories--idopening-and-closing-codacy-items) will also [unignore the issue at the repository level](../repositories/issues.md#ignoring-and-managing-issues).
+
+!!! info Ignoring and unignoring findings are [auditable actions](../organizations/audit-logs-for-organizations.md#security-and-risk-management).
+
 ## Exporting findings {: id="exporting-the-security-item-list"}
 
 !!! info "This feature is available only to organization admins and organization managers"