Skip to content

Commit 6b088b0

Browse files
authored
Add documentation for OS Calendar feature (#14430)
1 parent ac27aa1 commit 6b088b0

5 files changed

Lines changed: 62 additions & 1 deletion

File tree

docs/assets/images/OSC_ss1.png

244 KB
Loading

docs/assets/images/OSC_ss2.png

321 KB
Loading

docs/assets/images/OSC_ss3.png

392 KB
Loading
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: "Calendar"
3+
description: "How to use the Calendar in DefectDojo Pro"
4+
audience: opensource
5+
weight: 2
6+
---
7+
8+
DefectDojo’s Calendar provides a centralized timeline view of all Engagements and Tests with defined start and end dates, allowing Users to quickly understand testing activity across Products, identify scheduling overlaps, and navigate directly to related objects.
9+
10+
When a User creates an Engagement or Test and defines start and end dates, a corresponding entry is automatically added to the Calendar. Entries appear on all dates from the defined start date through and inclusive of the defined end date.
11+
12+
## Accessing Calendar
13+
14+
The Calendar page is accessible via the Calendar button in the sidebar.
15+
16+
![image](images/OSC_ss3.png)
17+
18+
## Visiblity and Permissions
19+
20+
### Visibility
21+
22+
The Calendar page includes filters at the top and a monthly Calendar grid below. Use the navigation controls above the Calendar to move between months.
23+
24+
The monthly view is displayed as a fixed six-week grid, beginning with the week containing the first day of the selected month.
25+
26+
The visible entries within the Calendar can be filtered based on object type (Engagements or Tests) and the Testing Lead, which is established within the settings of the Engagement or Test. After selecting filter criteria, click Apply to refresh the Calendar view.
27+
28+
Only one object type can be displayed at a time. Switching between Engagements and Tests updates the Calendar view accordingly.
29+
30+
### Permissions
31+
32+
The Calendar respects DefectDojo’s object-level permissions. Users only see Engagements and Tests they are authorized to access.
33+
34+
## Viewing and Interacting with Entries
35+
36+
Within each date cell, entries are sorted alphabetically based on the object's name. Clicking an entry redirects to the corresponding object.
37+
38+
The number of viewable entries on each day is dynamic and changes depending on screen size and browser zoom level. If the number of entries exceeds the available space in a date cell, a link formatted as “+X more” appears at the bottom of the cell.
39+
40+
![image](images/OSC_ss1.png)
41+
42+
Click the “+X more” link to open a modal displaying all entries for that date.
43+
44+
![image](images/OSC_ss2.png)
45+
46+
Importantly, the Calendar itself is a read-only view. Dates must be modified within the settings of the Engagement or Test object itself.
47+
48+
### Naming Logic
49+
50+
The naming of entries in the Calendar varies slightly depending on the object type.
51+
52+
Engagement entries include:
53+
- Product Name
54+
- Engagement Name
55+
- Testing Lead
56+
57+
Test entries include:
58+
- Product Name
59+
- Engagement Name
60+
- Test Type
61+
- Testing Lead

docs/content/asset_modelling/engagements_tests/PRO__calendar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Importantly, Calendar will only present Engagements and Tests to which the User
2929

3030
The monthly calendar will preview five entries on each day. Additional entries occurring on that day will be hidden from view unless the **"+ [X] events"** is clicked within the cell of any particular date. Once clicked, the calendar will shift from a monthly view to a daily view.
3131

32-
Clicking on an for a Test or Engagement will open a pop-up modal with additional information on that entry, including:
32+
Clicking on an entry for a Test or Engagement will open a pop-up modal with additional information on that entry, including:
3333
- Start and End Date
3434
- Test or Engagement Type
3535
- Lead

0 commit comments

Comments
 (0)