Skip to content

Commit 8f42916

Browse files
authored
docs: DefectDojo Pro Customizable Dashboards (dashboard_v2) (#15111)
* docs: add DefectDojo Pro Customizable Dashboards (dashboard_v2) Document the new Pro customizable dashboards (layouts + widget catalog, beta behind the dashboard_v2 feature flag): concepts + UI walkthrough, the /api/v2/dashboards/ REST API with a full lifecycle script, and a paste-in LLM prompt. Rework the dashboards index for OSS-vs-Pro, point the OSS Main Dashboard page's Pro section at the new docs, remove the obsolete custom-tiles page, and repoint inbound links to it. Authored by T. Walker - DefectDojo * docs: refine Pro dashboards nav, beta enablement language, and section ordering Authored by T. Walker - DefectDojo * docs: dark-mode dashboard screenshots, hero image, focus boxes, and LLM prompt copy button Authored by T. Walker - DefectDojo * docs: point Metrics & Reports nav at OSS Main Dashboard page The top-nav Metrics & Reports link targeted the dashboards section index (_index.md) — a chapter landing rendered without the left side menu. Restore it to the introduction_dashboard leaf page so the nav lands on a page with the full sidebar and version selector, consistent with every other top-nav item. Authored by T. Walker - DefectDojo
1 parent 528006e commit 8f42916

16 files changed

Lines changed: 909 additions & 433 deletions
206 KB
Loading
158 KB
Loading
141 KB
Loading
123 KB
Loading
133 KB
Loading
208 KB
Loading
131 KB
Loading

docs/content/asset_modelling/OS_hierarchy/OS__sla_configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can use SLAs as a way to represent your organizations remediation policies.
2121
* You can sort or filter Finding tables by SLA days.
2222
* SLA violations can be configured to trigger [Notifications](/admin/notifications/about_notifications/) to DefectDojo users assigned to the related Product.
2323
* In **DefectDojo Pro**, SLA performance is also tracked on the [Executive Insights and Remediation](/metrics_reports/pro_metrics/pro__overview/) Metrics Dashboards.
24-
* SLA compliance can also be used to create custom [Dashboard Tiles](/metrics_reports/dashboards/about_custom_dashboard_tiles/#sla-violation-tile) in **DefectDojo Pro**.
24+
* SLA compliance can also be surfaced on a custom [dashboard](/metrics_reports/dashboards/custom-dashboards/) in **DefectDojo Pro** — for example with an SLA Burndown or a filtered Count widget.
2525

2626
### Mitigated Within SLA status
2727

docs/content/asset_modelling/PRO_hierarchy/priority_sla.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ You can use SLAs as a way to represent your organizations remediation policies.
218218
* You can sort or filter Finding tables by SLA days.
219219
* SLA violations can be configured to trigger [Notifications](/admin/notifications/about_notifications/) to DefectDojo users assigned to the related Product.
220220
* In **DefectDojo Pro**, SLA performance is also tracked on the [Executive Insights and Remediation](/metrics_reports/pro_metrics/pro__overview/) Metrics Dashboards.
221-
* SLA compliance can also be used to create custom [Dashboard Tiles](/metrics_reports/dashboards/about_custom_dashboard_tiles/#sla-violation-tile) in **DefectDojo Pro**.
221+
* SLA compliance can also be surfaced on a custom [dashboard](/metrics_reports/dashboards/custom-dashboards/) in **DefectDojo Pro** — for example with an SLA Burndown or a filtered Count widget.
222222

223223
### Mitigated Within SLA status
224224

docs/content/metrics_reports/dashboards/Introduction_dashboard.md

Lines changed: 2 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "DefectDojo Main Dashboard"
33
description: "Working with the front page of DefectDojo"
44
weight: 1
5+
audience: opensource
56
aliases:
67
- /en/customize_dojo/dashboards/Introduction_dashboard
78
- /en/customize_dojo/dashboards/pro_dashboards
@@ -15,7 +16,7 @@ The Dashboard is likely the first page you'll see when you open DefectDojo. It s
1516
</div>
1617
<div class="version-pro">
1718

18-
![image](images/Introduction_to_Dashboard_Features.png)
19+
> **💡 DefectDojo Pro:** In DefectDojo Pro, the home page is a fully **customizable dashboard** — you build it from widgets and arrange them yourself, rather than using the fixed layout described below. See **[Customizable Dashboards](../custom-dashboards/)** for the concepts and a UI walkthrough. The rest of this page describes the open-source Main Dashboard.
1920
2021
</div>
2122

@@ -55,92 +56,3 @@ Superusers can toggle which charts appear on the dashboard. Navigate to the gear
5556
Select **Reset Dashboard Configuration** from the same menu to restore defaults.
5657

5758
</div>
58-
<div class="version-pro">
59-
60-
## Dashboard Components
61-
62-
* **Customizable Dashboard Tiles**, which you can use to visualize the metrics which are relevant to you.
63-
* **Pre\-built Dashboard Charts**, which visualize your team’s overall performance.
64-
65-
Each team member shares a single dashboard, but the results of the dashboard are restricted by their role and Product Membership. Team members will only see calculated stats for the Products, Engagements, Findings or other objects that they have access to. For more information, see our guides on [User Permissions and Roles](/admin/user_management/about_perms_and_roles).
66-
67-
### Dashboard Tiles
68-
69-
Tiles are designed to provide relevant information and speed up navigation within DefectDojo.
70-
71-
![image](images/Introduction_to_Dashboard_Features_2.png)
72-
73-
Tiles can:
74-
75-
* Act as shortcuts for particular sets of Findings, Products, or other objects
76-
* Visualize metrics related to your Product
77-
* Provide alerts on particular activity, track SLA Violations, failing imports or new Critical Findings
78-
79-
Tiles are pinned to the top section of your **🏠 Home** page.
80-
81-
To learn how to add and use dashboard tiles, see our [guide](/metrics_reports/dashboards/about_custom_dashboard_tiles).
82-
83-
### Dashboard Charts
84-
85-
Located beneath Dashboard Tiles, DefectDojo has five pre\-built charts:
86-
87-
* **Historical Finding Severity** pie\-chart
88-
* **Reported Finding Severity** histogram, by month
89-
* **Unassigned Answered Engagement Questionnaires** table
90-
* **Top 10 Graded Products** table
91-
* **Bottom 10 Graded Products** table
92-
93-
These charts can be added or removed from the dashboard via **Dashboard Configuration**.
94-
95-
#### Historical Finding Severity
96-
97-
This chart organizes all Findings created in DefectDojo by Severity, so that you can see the overall distribution of vulnerability levels in your environment.
98-
99-
![image](images/Introduction_to_Dashboard_Features_3.png)
100-
101-
#### Reported Finding Severity
102-
103-
This chart allows you to monitor the volume and severity distribution of incoming Findings per month.
104-
105-
![image](images/Introduction_to_Dashboard_Features_4.png)
106-
107-
#### Unassigned Answered Engagement Questionnaires
108-
109-
If you have completed Engagement Questionnaires for review, those will be listed in this table.
110-
111-
![image](images/Introduction_to_Dashboard_Features_5.png)
112-
113-
#### Top 10 / Bottom 10 Graded Products
114-
115-
This section summarizes the Graded performance of each Product in your instance, counting the Highest and Lowest scoring Products.
116-
117-
![image](images/Introduction_to_Dashboard_Features_6.png)
118-
119-
Finding Counts of each severity are calculated by the tile, but note that Product Grade is only assigned based on Active Findings, so there may be Inactive Findings counted in this table which do not contribute to the Grade.
120-
121-
To understand how grades are calculated, see our guide to **[Product Health Grading](/asset_modelling/pro_hierarchy/product_health_grade/)**.
122-
123-
## Dashboard Configuration
124-
125-
Superusers can choose which Metrics Charts are displayed on the Dashboard. To do this, select the **Edit Dashboard Configuration** option from the top\-right hand gear menu.
126-
127-
![image](images/How-To_Edit_Dashboard_Configuration.png)
128-
This will open the **Dashboard Configuration Settings** window.
129-
130-
### Configuration Settings
131-
132-
![image](images/How-To_Edit_Dashboard_Configuration_2.png)
133-
134-
* **Display Graphs** determines whether or not the **Historical Finding Severity** and **Reported Finding Severity** charts are visible.
135-
* **Display Surveys determines whether or not the Unassigned Answered Engagement Questionnaires table is visible.**
136-
* **Display Data Tables determines whether or not the Top 10 / Bottom 10 Graded Products tables are visible.**
137-
138-
### Reset Dashboard Configuration
139-
140-
If you would like to reset your Dashboard to a default state, you can do so by selecting **Reset Dashboard Configuration** from the top\-right hand gear menu.
141-
142-
![image](images/How-To_Edit_Dashboard_Configuration_3.png)
143-
144-
**Note that this will remove any Custom Dashboard Tiles which have been added to your instance.**
145-
146-
</div>

0 commit comments

Comments
 (0)