Merge pull request #66 from jvz/similar-findings

Add docs for similar findings
DefectDojo · Dec 16, 2019 · 1a12ba7 · 1a12ba7
2 parents 4309ac3 + 09ca54c
commit 1a12ba7
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/docs/_static/similar_finding_1.png b/docs/_static/similar_finding_1.png
diff --git a/docs/_static/similar_finding_2.png b/docs/_static/similar_finding_2.png
diff --git a/docs/features.rst b/docs/features.rst
@@ -332,6 +332,25 @@ Automatically Flag Duplicate Findings
     and have the same CWE or title, Dojo marks the less recent finding as a duplicate. When deduplication is enabled, a
     list of deduplicated findings is added to the engagement view.
 
+Similar Findings Visualization:
+
+.. image:: _static/similar_finding_1.png
+    :alt: Similar findings list
+
+.. image:: _static/similar_finding_2.png
+    :alt: Similar findings list with a duplicate
+
+Similar Findings
+    While viewing a finding, similar findings within the same product are
+    listed along with buttons to mark one finding a duplicate of the other.
+    Clicking the "Use as original" button on a similar finding will mark that
+    finding as the original while marking the viewed finding as a duplicate.
+    Clicking the "Mark as duplicate" button on a similar finding will mark that
+    finding as a duplicate of the viewed finding. If a similar finding is
+    already marked as a duplicate, then a "Reset duplicate status" button is
+    shown instead which will remove the duplicate status on that finding along
+    with marking it active again.
+
 Metrics
 -------