Merge branch 'staging-new-docs' of https://github.com/paulOsinski/django-DefectDojo into staging-new-docs

Author: paulOsinski

docs/assets/images/metrics_image1.png

@@ -5,7 +5,7 @@ summary: ""
 date: 2023-09-07T16:06:50+02:00
 lastmod: 2023-09-07T16:06:50+02:00
 draft: false
-weight: 2
+weight: 3
 chapter: true
 seo:
   title: "" # custom title (optional)

docs/assets/images/metrics_image2.png

@@ -4,10 +4,8 @@ summary: ""
 date: 2023-09-07T16:06:50+02:00
 lastmod: 2023-09-07T16:06:50+02:00
 draft: false
-weight: 7
+weight: 1
 chapter: true
-sidebar:
-  collapsed: true
 seo:
   title: "" # custom title (optional)
   description: "" # custom description (recommended)

docs/assets/images/metrics_image3.png

@@ -0,0 +1,18 @@
+---
+title: "Executive Insights"
+description: "How to Leverage Metrics in DefectDojo Pro"
+audience: pro
+weight: 3
+---
+
+The **Executive Insights** metrics page provides an aggregated view of application security risk across your organization. As it is design for executive-level consumption, this dashboard focuses exclusively on Organizations and Assets, emphasizing trends and outcomes rather than individual Findings.
+
+![image](images/pro_dashboards_1.png)
+
+Within Executive Insights, Users may select a timeframe, Organization, Asset, or Tag from the filter list, which will populate an adjoining table with the resulting Findings. It will also change the results in various charts and graphs below. 
+
+If no filters are selected, the table will display the status of all Organizations, Assets, and Tags. 
+
+The first table provides a birdseye view of your overall security posture. There are also two separate tables for your Organizations and Assets.
+
+Figures will populate within each table depending on the filters applied. Clicking any hyperlinked figure within a cell will open a separate tab with a corresponding Findings Table.

docs/assets/images/metrics_image4.gif

@@ -0,0 +1,56 @@
+---
+title: "Pro Metrics Overview"
+description: "How to Leverage Metrics in DefectDojo Pro"
+audience: pro
+weight: 2
+---
+
+The DefectDojo Pro UI has various Metrics dashboards to help visualize your current security posture. Each dashboard allows stakeholders at different levels of the organization to make informed decisions without needing to interpret raw data or navigate individual Findings. These dashboards include:
+* [Executive Insights](#executive-insights)
+* [Priority Insights](#priority-insights)
+* [Program Insights](#program-insights)
+* [Remediation Insights](#remediation-insights)
+* [Tool Insights](#tool-insights)
+
+![Metrics overview](images/metrics_image1.png)
+
+## Metrics Features
+
+Before elaborating on each particular dashboard, there are some commonalities between all dashboards that are worth reviewing.
+
+### Filtering
+
+All Metrics can be filtered by timeframe, Organization, Asset, and Tag. After adjusting the filter as desired, Apply Filter must be clicked in order for the filter to take effect. If you wish to export a PDF of all charts, tables, and graphs on the dashboard as currently filtered, click Export as PDF. 
+
+The filtering timeframe is limited to the past year, but can otherwise be adjusted to include the past 7, 14, 30, 90, or 180 days.
+
+Note that filter parameters are rendered in the URL, so you can bookmark multiple pages with various filter parameters.  This can be useful for quick reference, or for consistently generating a particular kind of report.
+
+### Submenus 
+
+Each graph has a ⋮ kebab menu in the top right of each view with the following features:
+* Force Refresh — Manually refreshes to incorporate any new updates in the data. 
+* Expand Plot — Opens the same chart in a larger pop-up modal.
+* Download Plot as SVG — Downloads the chart as an SVG file.
+* View as Table — Shows the data from the chart in table format.
+    * Each column of the table can be toggled to appear in ascending or descending order when clicked. You can also download each table.
+
+![Kebab menu contents](images/metrics_image2.png)
+
+### Access
+
+The Metrics section will only represent data from the Organizations and Assets that each User has the appropriate permissions to view. A User with access limited to a single Asset will only be able to see Metrics for that particular Asset, but if they don’t have access to the other Assets within the parent Organization, data from those other Assets won't be represented in Metrics. 
+
+### Viewing Data Within Charts
+
+The X-axis of line charts will always represent the current timeframe filter. Hovering your cursor over a line chart will cause a modal to appear with a count of the figures on the Y-axis at that point in time. 
+
+![Graph pop-up modal](images/metrics_image3.png)
+
+### Toggling Results
+
+Users can toggle certain categories of Findings as viewable and nonviewable in the chart by clicking on their respective color/name at the top of each chart. 
+
+For example, in the Active Findings by Severity chart below, if you only wanted to see Findings with a High or Critical severity, you would click Medium, Low, and Info at the top to remove those results from the chart. Clicking Medium, Low, and Info again would make those results reappear. 
+
+![Toggling graph results gif](images/metrics_image4.gif)