Docs maintenance - v2.41.4 (#11484)

* update docs 'jira' * rename finding_status_definitions * update docs 'working with Findings' * update docs 'dashboard-notifications' * reorganize sidebar * add emoji logos to headers * fix broken links * rm 'upgrading' pages from search results * rm aws ami reference * Update docs/content/en/customize_dojo/dashboard_notifications/about_custom_dashboard_tiles.md Co-authored-by: Charles Neill <[email protected]> * Update docs/content/en/customize_dojo/dashboard_notifications/about_custom_dashboard_tiles.md Co-authored-by: Charles Neill <[email protected]> * Update about_notifications.md * update dashboard tiles article * finish notifications QA --------- Co-authored-by: Paul Osinski <[email protected]> Co-authored-by: Charles Neill <[email protected]>
DefectDojo · Jan 2, 2025 · a99f02d · a99f02d
1 parent abd1e7f
commit a99f02d
Show file tree

Hide file tree

Showing 127 changed files with 814 additions and 1,143 deletions.
diff --git a/docs/assets/images/DD-Hierarchy.drawio b/docs/assets/images/DD-Hierarchy.drawio
diff --git a/docs/assets/images/How-To_Add,_Edit_or_Delete_Dashboard_Tiles_3.png b/docs/assets/images/How-To_Add,_Edit_or_Delete_Dashboard_Tiles_3.png
diff --git a/docs/assets/images/dd-hierarchy.png b/docs/assets/images/dd-hierarchy.png
diff --git a/docs/assets/images/jira-instance-beta.png b/docs/assets/images/jira-instance-beta.png
diff --git a/docs/assets/images/jira-project-settings.png b/docs/assets/images/jira-project-settings.png
diff --git a/docs/assets/images/notifs_email.png b/docs/assets/images/notifs_email.png
diff --git a/docs/assets/svgs/DD-Hierarchy.svg b/docs/assets/svgs/DD-Hierarchy.svg
diff --git a/docs/content/en/api/_index.md b/docs/content/en/api/_index.md
@@ -1,5 +1,5 @@
 ---
-title: "API Documentation"
+title: "🤖 API Documentation"
 description: ""
 summary: ""
 date: 2023-09-07T16:06:50+02:00

diff --git a/docs/content/en/changelog/_index.md b/docs/content/en/changelog/_index.md
@@ -1,5 +1,5 @@
 ---
-title: "Changelog"
+title: "📝 Changelog"
 description: ""
 summary: ""
 date: 2023-09-07T16:06:50+02:00

diff --git a/docs/content/en/cloud_management/_index.md b/docs/content/en/cloud_management/_index.md
@@ -1,11 +1,11 @@
 ---
-title: "DefectDojo Cloud Manager"
+title: "☁️ DefectDojo Cloud"
 description: "Manage Your DefectDojo subscription"
 summary: ""
 date: 2023-09-07T16:06:50+02:00
 lastmod: 2023-09-07T16:06:50+02:00
 draft: false
-weight: 2
+weight: 6
 chapter: true
 seo:
   title: "" # custom title (optional)

diff --git a/docs/content/en/cloud_management/additional-cloud-instance.md b/docs/content/en/cloud_management/additional-cloud-instance.md
@@ -1,6 +1,7 @@
 ---
 title: "Set up an additional Cloud instance"
 description: "Add a test, dev, or other DefectDojo instance to your account"
+weight: 2
 ---
 
 The process for adding a second Cloud instance is more or less the same as adding your first instance. This guide assumes you've already set up your initial DefectDojo server, and have an agreement with our Sales team to add another instance.

diff --git a/docs/content/en/cloud_management/connectivity-troubleshooting.md b/docs/content/en/cloud_management/connectivity-troubleshooting.md
@@ -1,6 +1,7 @@
 ---
 title: "Connectivity Troubleshooting"
 description: "Reconnect to your DefectDojo Instance"
+weight: 2
 ---
 
 If you have difficulty accessing your DefectDojo instance, here are some steps you can follow to get reconnected:

diff --git a/docs/content/en/cloud_management/using-cloud-manager.md b/docs/content/en/cloud_management/using-cloud-manager.md
@@ -1,6 +1,7 @@
 ---
 title: "Using the Cloud Manager"
 description: "Manage your subscription and account settings"
+weight: 1
 ---
 
 Logging into DefectDojo's Cloud Manager allows you to configure your account settings and manage your subscription with DefectDojo Cloud.

diff --git a/docs/content/en/connecting_your_tools/_index.md b/docs/content/en/connecting_your_tools/_index.md
@@ -1,5 +1,5 @@
 ---
-title: "Connect Your Tools"
+title: "🛠️ Connect Your Tools"
 description: "Import data from 190+ different security tools (and counting)"
 summary: ""
 date: 2023-09-07T16:06:50+02:00

diff --git a/docs/content/en/connecting_your_tools/connectors/_index.md b/docs/content/en/connecting_your_tools/connectors/_index.md
@@ -5,7 +5,7 @@ summary: ""
 date: 2023-09-07T16:06:50+02:00
 lastmod: 2023-09-07T16:06:50+02:00
 draft: false
-weight: 3
+weight: 4
 chapter: true
 sidebar:
   collapsed: true

diff --git a/docs/content/en/connecting_your_tools/import_intro.md b/docs/content/en/connecting_your_tools/import_intro.md
@@ -1,5 +1,5 @@
 ---
-title: "Import Methods"
+title: "Import Method Comparison"
 description: "Learn how to import data manually, through the API, or via a connector"
 weight: 1
 ---

diff --git a/docs/content/en/connecting_your_tools/import_scan_files/_index.md b/docs/content/en/connecting_your_tools/import_scan_files/_index.md
@@ -1,11 +1,11 @@
 ---
-title: "Import Scans"
+title: "How To Import Data"
 description: "Use DefectDojo's Import / Reimport to ingest data and build a pipeline"
 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
 sidebar:
   collapsed: true

diff --git a/docs/content/en/connecting_your_tools/parsers/_index.md b/docs/content/en/connecting_your_tools/parsers/_index.md
@@ -1,5 +1,5 @@
 ---
-title: "Supported Reports"
+title: "Supported Report Types"
 description: "DefectDojo has the ability to import scan reports from a large number of security tools."
 draft: false
 weight: 5

diff --git a/docs/content/en/connecting_your_tools/parsers/api/_index.md b/docs/content/en/connecting_your_tools/parsers/api/_index.md
@@ -1,7 +1,7 @@
 ---
 title: "API Pull"
 description: "Report pulled to DefectDojo via API exposed by scanning service"
-weight: 2
+weight: 3
 chapter: true
 sidebar:
   collapsed: true

diff --git a/docs/content/en/connecting_your_tools/parsers/file/_index.md b/docs/content/en/connecting_your_tools/parsers/file/_index.md
@@ -1,7 +1,7 @@
 ---
 title: "Files"
 description: "Report uploaded to DefectDojo as files"
-weight: 1
+weight: 2
 chapter: true
 sidebar:
   collapsed: true

diff --git a/docs/content/en/connecting_your_tools/parsers/generic_findings_import.md b/docs/content/en/connecting_your_tools/parsers/generic_findings_import.md
@@ -1,6 +1,7 @@
 ---
 title: "Generic Findings Import"
 toc_hide: true
+weight: 1
 ---
 
 You can use Generic Findings Import as a method to ingest JSON or CSV files into DefectDojo which are not already in the supported parsers list.

diff --git a/docs/content/en/customize_dojo/_index.md b/docs/content/en/customize_dojo/_index.md
@@ -0,0 +1,15 @@
+---
+title: "👥 Management & Customization"
+description: "Dashboards, User Access"
+summary: ""
+date: 2023-09-07T16:06:50+02:00
+lastmod: 2023-09-07T16:06:50+02:00
+draft: false
+weight: 5
+chapter: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
diff --git a/...nt/en/dashboard/Introduction_dashboard.md → ...d_notifications/Introduction_dashboard.md b/...nt/en/dashboard/Introduction_dashboard.md → ...d_notifications/Introduction_dashboard.md
@@ -1,19 +1,21 @@
 ---
-title: "Introduction to Dashboard Features"
+title: "DefectDojo Main Dashboard"
 description: "Working with the front page of DefectDojo"
+weight: 1
 ---
 
 The Dashboard is likely the first page you'll see when you open DefectDojo. It summarizes your team’s performance, and provides tracking tools to monitor specific areas of your vulnerability tracking environment.
 
 ![image](images/Introduction_to_Dashboard_Features.png)
-The dashboard has two components:
+
+## Dashboard Components
 
 * **Customizable Dashboard Tiles**, which you can use to visualize the metrics which are relevant to you.
 * **Pre\-built Dashboard Charts**, which visualize your team’s overall performance.
 
 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](https://docs.defectdojo.com/en/user_management/about-permissions--roles/).
 
-# Dashboard Tiles
+### Dashboard Tiles
 
 Tiles are designed to provide relevant information and speed up navigation within DefectDojo. 
 
@@ -27,12 +29,9 @@ Tiles can:
 
 Tiles are pinned to the top section of your **🏠 Home** page.
 
-For more information about creating and editing Dashboard Tiles, see our guides on this topic**:**
-
-* [Dashboard Tile Summary](https://docs.defectdojo.com/en/dashboard/about_custom_dashboard_tiles/)
-* [Add, Edit or Delete Dashboard Tiles](https://docs.defectdojo.com/en/dashboard/add_edit_delete_dashboard_tiles/)
+To learn how to add and use dashboard tiles, see our [guide](../about_custom_dashboard_tiles).
 
-## Dashboard Charts
+### Dashboard Charts
 
 Located beneath Dashboard Tiles, DefectDojo has five pre\-built charts:
 
@@ -44,35 +43,53 @@ Located beneath Dashboard Tiles, DefectDojo has five pre\-built charts:
 
 These charts can be added or removed from the dashboard via **[Dashboard Configuration](https://docs.defectdojo.com/en/dashboard/how-to-edit-dashboard-configuration/)**.
 
-### Historical Finding Severity
+#### Historical Finding Severity
 
 This chart organizes all Findings created in DefectDojo by Severity, so that you can see the overall distribution of vulnerability levels in your environment.
 
 ![image](images/Introduction_to_Dashboard_Features_3.png)
 
-### Reported Finding Severity
+#### Reported Finding Severity
 
 This chart allows you to monitor the volume and severity distribution of incoming Findings per month.
 
 ![image](images/Introduction_to_Dashboard_Features_4.png)
 
-### Unassigned Answered Engagement Questionnaires
+#### Unassigned Answered Engagement Questionnaires
 
 If you have completed Engagement Questionnaires for review, those will be listed in this table. 
 
 ![image](images/Introduction_to_Dashboard_Features_5.png)
 
-### Top 10 / Bottom 10 Graded Products
+#### Top 10 / Bottom 10 Graded Products
 
 This section summarizes the Graded performance of each Product in your instance, counting the Highest and Lowest scoring Products.
 
 ![image](images/Introduction_to_Dashboard_Features_6.png)
 
 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.
 
-To understand how grades are calculated, see our guide to **[Product Health Grading](https://docs.defectdojo.com/en/working_with_findings/organizing_engagements_tests/product-health-grade/)**.
+To understand how grades are calculated, see our guide to **[Product Health Grading](/en/working_with_findings/organizing_engagements_tests/product-health-grade/)**.
+
+## Dashboard Configuration
+
+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.
+
+![image](images/How-To_Edit_Dashboard_Configuration.png)
+This will open the **Dashboard Configuration Settings** window.
+
+### Configuration Settings
+
+![image](images/How-To_Edit_Dashboard_Configuration_2.png)
+
+* **Display Graphs** determines whether or not the **Historical Finding Severity** and **Reported Finding Severity** charts are visible.
+* **Display Surveys determines whether or not the Unassigned Answered Engagement Questionnaires table is visible.**
+* **Display Data Tables determines whether or not the Top 10 / Bottom 10 Graded Products tables are visible.**
+
+### Reset Dashboard Configuration
+
+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.
 
-# Next Steps
+![image](images/How-To_Edit_Dashboard_Configuration_3.png)
 
-* Change or reset your dashboard display by **[editing your dashboard configuration](https://docs.defectdojo.com/en/dashboard/how-to-edit-dashboard-configuration/)**.
-* Learn how to customize your DefectDojo instance with **[custom Dashboard Tiles](https://docs.defectdojo.com/en/dashboard/about-custom-dashboard-tiles/)**.
+**Note that this will remove any Custom Dashboard Tiles which have been added to your instance.**
diff --git a/docs/content/en/dashboard/_index.md → ...ze_dojo/dashboard_notifications/_index.md b/docs/content/en/dashboard/_index.md → ...ze_dojo/dashboard_notifications/_index.md
@@ -1,5 +1,5 @@
 ---
-title: "Set Up Your Dashboard"
+title: "Dashboards"
 summary: ""
 date: 2023-09-07T16:06:50+02:00
 lastmod: 2023-09-07T16:06:50+02:00