Skip to content

Commit 0eaf07a

Browse files
committed
inprogress - set up defectdojo structure
1 parent 73a21a4 commit 0eaf07a

52 files changed

Lines changed: 613 additions & 364 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/config/_default/menus/menus.en.toml

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,38 @@
1010

1111
[[main]]
1212
name = "Triage Findings ⏷"
13-
url = "/triage_findings/"
13+
url = "/triage_findings/findings/intro_to_findings/"
1414
weight = 12
1515

1616
[[main]]
17-
name = "Metrics & reports"
18-
url = "/metrics_reports/"
17+
name = "Model your assets"
18+
url = "/asset_modelling/hierarchy/pro__assets_organizations/"
1919
weight = 13
2020

2121
[[main]]
22-
name = "Admin"
23-
url = "/admin/"
22+
name = "Metrics & reports"
23+
url = "/metrics_reports/dashboards/introduction_dashboard/"
2424
weight = 14
2525

26+
[[main]]
27+
name = "Admin ⏷"
28+
url = "/admin/admin_intro/intro/"
29+
weight = 16
30+
2631
[[main]]
2732
name = "Issue tracking ⏷"
28-
url = "/issue_tracking/"
29-
weight = 14
33+
url = "/issue_tracking/intro/intro/"
34+
weight = 15
3035

3136
[[main]]
3237
name = "Automation ⏷"
33-
url = "/automation/"
34-
weight = 14
38+
url = "/automation/api/api-v2-docs/"
39+
weight = 15
3540

3641
[[main]]
3742
name = "Supported tools ⏷"
3843
url = "/supported_tools/"
39-
weight = 15
44+
weight = 16
4045

4146
[[social]]
4247
name = "YouTube"

docs/config/_default/params.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ mainSections = ["docs"]
5454
"metrics_reports",
5555
"admin",
5656
"automation",
57+
"asset_modelling",
5758
"issue_tracking"] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"])
5859

5960
toTopButton = false # false (default) or true
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Intro"
3+
description: ""
4+
summary: ""
5+
date: 2023-09-07T16:06:50+02:00
6+
lastmod: 2023-09-07T16:06:50+02:00
7+
draft: false
8+
weight: 3
9+
chapter: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
robots: "" # custom robot tags (optional)
15+
exclude_search: true
16+
---
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: "DefectDojo Admin Controls"
3+
description: "Administrative controls for configuring, securing, and maintaining your DefectDojo instance."
4+
weight: 0
5+
---
6+
7+
Admin actions in DefectDojo provide the controls needed to configure and maintain the platform across your organization. These actions are designed for administrators who are responsible for user management, system configuration, and ensuring DefectDojo operates securely and reliably at scale.
8+
9+
Administrative actions allow you to manage core aspects of DefectDojo, including authentication methods, user access, global settings, and integrations. From initial setup to ongoing maintenance, these controls define how DefectDojo behaves and how users interact with it.

docs/content/admin/notifications/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ lastmod: 2023-09-07T16:06:50+02:00
66
draft: false
77
weight: 7
88
chapter: true
9-
sidebar:
10-
collapsed: true
119
seo:
1210
title: "" # custom title (optional)
1311
description: "" # custom description (recommended)

docs/content/admin/user_management/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ lastmod: 2023-09-07T16:06:50+02:00
77
draft: false
88
weight: 5
99
chapter: true
10-
sidebar:
11-
collapsed: true
1210
seo:
1311
title: "" # custom title (optional)
1412
description: "" # custom description (recommended)

docs/content/admin/user_management/pro_permissions_overhaul.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,34 @@
11
---
2-
title: "🟧 Set Permissions in Pro"
2+
title: "Set Permissions in Pro"
33
description: "Overhaul, pro feature"
44
weight: 3
5+
audience: pro
56
---
67

8+
## Introduction to Permission Types
9+
10+
Individual users have four different kinds of permission that they can be assigned:
11+
12+
* Users can be assigned as **Members to Products or Product Types**. This allows them to view and interact with Data Types (Product Types, Products, Engagements, Tests and Findings) in DefectDojo depending on the role they are assigned on the specific Product. Users can have multiple Product or Product Type memberships, with different levels of access.
13+
14+
* Users can also have **Configuration Permissions** assigned, which allow them to access configuration pages in DefectDojo. Configuration Permissions are not related to Products or Product Types.
15+
16+
* Users can be assigned **Global Roles**, which give them a standardized level of access to all Products and Product Types.
17+
18+
* Users can be set up as **Superusers**: administrator level roles which give them control and access to all DefectDojo data and configuration.
19+
20+
You can also create Groups if you want to assign Product Membership, Configuration Permissions or Global Roles to a group of users at the same time. If you have a large number of users in DefectDojo, such as a dedicated testing team for a particular Product, Groups may be a more helpful feature.
21+
22+
## Superusers \& Global Roles
23+
24+
Part of your Role\-Based Access Control (RBAC) configuration may require you to create additional Superusers, or users with Global Roles.
25+
26+
* Superusers (Admins) have no limitations in the system. They can change all settings, manage users and have read / write access to all data. They can also change access rules for all users in DefectDojo. Superusers will also receive notifications for all system issues and alerts.
27+
* Users with Global Roles can view and interact with any Data Type (Product Types, Products, Engagements, Tests and Findings) in DefectDojo depending on their assigned Role. For more information about each Role and associated privileges, please refer to our Introduction to Roles article.
28+
* Users can also have specific Configuration Permissions assigned, allowing them to access certain DefectDojo configuration pages. Users have no Configuration Permissions by default.
29+
30+
By default, the first account created on a new DefectDojo instance will have Superuser permissions. That user will be able to edit permissions for all subsequent DefectDojo users. Only an existing Superuser can add another superuser, or add a Global Role to a user.
31+
732
Permissions in <span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Pro</span> have been simplified, to make it easier to assign object access. This feature can be accessed through the [Pro UI](/en/about_defectdojo/ui_pro_vs_os/).
833

934
### Opening the Permissions window

docs/content/admin/user_management/set_user_permissions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Set a User's permissions"
33
description: "How to grant Roles & Permissions to a user, as well as superuser status"
44
weight: 2
5+
audience: opensource
56
---
67

78
## Introduction to Permission Types
@@ -42,7 +43,7 @@ By default, the first account created on a new DefectDojo instance will have Sup
4243

4344
4. From the Edit User page:
4445
45-
For Superuser Status, check off the ☑️Superuser Status box, located in the user's Default Information.
46+
For Superuser Status, check off the ☑️ Superuser Status box, located in the user's Default Information.
4647
4748
To assign a Global Role, select one from the dropdown Global Role menu at the bottom of the page.
4849

docs/content/triage_findings/working_with_findings/_index.md renamed to docs/content/asset_modelling/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "🚩 Work With Findings"
2+
title: "Organize DefectDojo"
33
date: 2021-02-02T20:46:29+01:00
44
draft: false
55
type: docs
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "Engagements & Tests"
3+
date: 2021-02-02T20:46:29+01:00
4+
draft: false
5+
type: docs
6+
weight: 1
7+
exclude_search: true
8+
---

0 commit comments

Comments
 (0)