diff --git a/docs/organizations/audit-logs-for-organizations.md b/docs/organizations/audit-logs-for-organizations.md index e9eb523b48..0535ac31f2 100644 --- a/docs/organizations/audit-logs-for-organizations.md +++ b/docs/organizations/audit-logs-for-organizations.md @@ -58,6 +58,8 @@ The sections below list the events that Codacy logs for your organization at use | Make coding standard default |Coding standard was made the default|`organizations.codingstandards.setdefault`| | Delete coding standard |Coding standard deleted|`organizations.codingstandards.delete`| | Export [security items](./managing-security-and-risk.md) |Export security items|`organizations.security.items.export`| +| Ignore security item |Security item was ignored|`organizations.security.items.ignore`| +| Unignore security item |Security item was unignored|`organizations.security.items.unignore`| ### Repository diff --git a/docs/organizations/images/security-risk-management-finding-ignore.png b/docs/organizations/images/security-risk-management-finding-ignore.png new file mode 100644 index 0000000000..c3d8f53651 Binary files /dev/null and b/docs/organizations/images/security-risk-management-finding-ignore.png differ diff --git a/docs/organizations/images/security-risk-management-finding-unignore-list.png b/docs/organizations/images/security-risk-management-finding-unignore-list.png new file mode 100644 index 0000000000..d5901d3a41 Binary files /dev/null and b/docs/organizations/images/security-risk-management-finding-unignore-list.png differ diff --git a/docs/organizations/images/security-risk-management-finding-unignore.png b/docs/organizations/images/security-risk-management-finding-unignore.png new file mode 100644 index 0000000000..1456e68d98 Binary files /dev/null and b/docs/organizations/images/security-risk-management-finding-unignore.png differ diff --git a/docs/organizations/managing-security-and-risk.md b/docs/organizations/managing-security-and-risk.md index e93d0e9899..45748cd6ba 100644 --- 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" + +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. + +![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 addressing 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." + +!!! 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)." + +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. + +![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](#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. + +Unignoring a finding reverts the effects of ignoring it. + +![Security and risk management finding unignore](images/security-risk-management-finding-unignore.png) + +!!! Important "Unignoring findings detected on [Git repositories](#opening-and-closing-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#organization)." + ## Exporting findings {: id="exporting-the-security-item-list"} !!! info "This feature is available only to organization admins and organization managers"