Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs Updates: Feb #11791

Merged
merged 22 commits into from
Feb 21, 2025
Merged

Docs Updates: Feb #11791

merged 22 commits into from
Feb 21, 2025

Conversation

paulOsinski
Copy link
Contributor

@paulOsinski paulOsinski commented Feb 10, 2025 •
edited
Loading

  • Retitle articles to specify OS context
  • Remove index pages and other irrelevant articles from search
  • Add more notes on windows CLI tool installation
  • Add docs on Universal Parser (upcoming Pro feature)
  • Adds docs for Rules Engine (upcoming Pro feature)
  • Adds list of Pro features
  • Add back defectdojo.com/pricing links
  • Add an SCSS override to fix the 'static width central column' issue and accommodate wider screens

[sc-8049]
[sc-8970]
[sc-9508]
[sc-10106]
[sc-10136]

@github-actions github-actions bot added the docs label Feb 10, 2025
@dryrunsecurity DryRunSecurity
Copy link

dryrunsecurity bot commented Feb 10, 2025 •
edited
Loading

DryRun Security Summary

Documentation updates for DefectDojo include adding search exclusion configurations and minor content changes, with some security considerations around information disclosure and configuration risks.

Expand for full summary

This pull request updates documentation for DefectDojo, primarily adding exclude_search: true configurations to multiple documentation pages and making minor content updates across various markdown files.

Security Findings:

  1. Potential Information Disclosure: Font path URLs in _custom.scss reveal internal directory structure, which could aid in reconnaissance
  2. URL Exposure: Added links to DefectDojo's pricing page could provide insights into service infrastructure
  3. Potential Configuration Risk: Instructions for disabling Windows Smartscreen in external_tools.md could reduce system security
  4. Multiple documentation pages now exclude search indexing, which might intentionally limit content discoverability

Code Analysis

We ran 9 analyzers against 17 files and 1 analyzer had findings. 8 analyzers had no findings.

Analyzer Findings
Configured Codepaths Analyzer 2 findings

Overall Riskiness

🔴 Risk threshold exceeded.

We've notified @mtesauro, @grendel513.

View PR in the DryRun Dashboard.

@paulOsinski paulOsinski changed the title Docs Updates: remove irrelevant pages from search Docs Updates: Feb Feb 12, 2025
@github-actions github-actions bot added the ui label Feb 12, 2025
mtesauro
mtesauro approved these changes Feb 15, 2025
View reviewed changes
Copy link
Contributor

@mtesauro mtesauro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@Maffooch Maffooch merged commit 805f617 into DefectDojo:master Feb 21, 2025
71 of 73 checks passed
valentijnscholten pushed a commit that referenced this pull request Feb 22, 2025
@paulOsinski @valentijnscholten
Docs Updates: Feb (#11791)
bc772f3 
* exclude archived docs from search

* rm index files from search results

* fix typo - CWE to CVE

* update external_tools.md with additional windows options

* remove outdated github.io links

* specify that EPSS sync is pro-only

* add universal parser documentation

* add beta notice to Universal Parser

* Update universal_parser.md

* add back defectdojo.com/pricing links

* add scss change to fix 'central column' issue

* add rules engine Pro documentation

* change casing for screenshots

* create pro features list, add to header

* Rename Enabling_Deduplication_within_an_Engagement.png to enabling_deduplication_within_an_engagement.png

* Rename Enabling_Deduplication_within_an_Engagement_2.png to enabling_deduplication_within_an_engagement_2.png

* Rename Enabling_Deduplication_within_an_Engagement_3.png to enabling_deduplication_within_an_engagement_3.png

* Rename Enabling_Deduplication_within_an_Engagement_4.png to enabling_deduplication_within_an_engagement_4.png

---------

Co-authored-by: Paul Osinski <[email protected]>
Maffooch added a commit that referenced this pull request Feb 24, 2025
@Maffooch @manuel-sommer
@paulOsinski @rossops
Release: Merge back 2.43.4 into dev from: master-into-dev/2.43.4-2.44…
5d484e4 
….0-dev (#11888)

* Update versions in application files

* Return Feedback about wrong File Format in ZAP (#11772)

* Return Feedback about wrong File Format in ZAP

* ruff

* Surveys: Correct Question 404 (#11862)

* Surveys: Correct Question 404

When editing a survey question, a 404 is presented for a valid object. At some point, the content type for Questions changed to `Defect Dojo` (the verbose name of the app) rather than `dojo` (the common name)

There is only one place where the name of the content type is accessed, so adding some backward compatible checks corrected the issue

[sc-10195]

* Update views.py

* API Tags: Add filter for `AND` expressions (#11743)

* API Tags: Add filter for `AND` expressions

* Fix some ruff stuff

* Small corrections

* Update dojo/filters.py

* Release Notes: 2.43.3 (#11857)

* add 2.43.0 changelog

* add 2.43.1

* v2.43.2

* 2.43.3

---------

Co-authored-by: Paul Osinski <[email protected]>

* Docs Updates: Feb (#11791)

* exclude archived docs from search

* rm index files from search results

* fix typo - CWE to CVE

* update external_tools.md with additional windows options

* remove outdated github.io links

* specify that EPSS sync is pro-only

* add universal parser documentation

* add beta notice to Universal Parser

* Update universal_parser.md

* add back defectdojo.com/pricing links

* add scss change to fix 'central column' issue

* add rules engine Pro documentation

* change casing for screenshots

* create pro features list, add to header

* Rename Enabling_Deduplication_within_an_Engagement.png to enabling_deduplication_within_an_engagement.png

* Rename Enabling_Deduplication_within_an_Engagement_2.png to enabling_deduplication_within_an_engagement_2.png

* Rename Enabling_Deduplication_within_an_Engagement_3.png to enabling_deduplication_within_an_engagement_3.png

* Rename Enabling_Deduplication_within_an_Engagement_4.png to enabling_deduplication_within_an_engagement_4.png

---------

Co-authored-by: Paul Osinski <[email protected]>

* Feb docs hotfix (#11870)

* Rename Enabling_Product-Level_Deduplication.png to enabling_product-level_deduplication.png

* Rename Enabling_Product-Level_Deduplication_2.png to enabling_product-level_ceduplication_2.png

* Rename enabling_product-level_ceduplication_2.png to enabling_product-level_deduplication_2.png

* Update versions in application files

* Update versions in application files

* Fixing flake 8

---------

Co-authored-by: DefectDojo release bot <[email protected]>
Co-authored-by: Cody Maffucci <[email protected]>
Co-authored-by: manuelsommer <[email protected]>
Co-authored-by: Paul Osinski <[email protected]>
Co-authored-by: Paul Osinski <[email protected]>
Co-authored-by: Ross E Esposito <[email protected]>
quirinziessler pushed a commit to quirinziessler/django-DefectDojo that referenced this pull request Feb 26, 2025
@paulOsinski @quirinziessler
Docs Updates: Feb (DefectDojo#11791)
2d0c2b9 
* exclude archived docs from search

* rm index files from search results

* fix typo - CWE to CVE

* update external_tools.md with additional windows options

* remove outdated github.io links

* specify that EPSS sync is pro-only

* add universal parser documentation

* add beta notice to Universal Parser

* Update universal_parser.md

* add back defectdojo.com/pricing links

* add scss change to fix 'central column' issue

* add rules engine Pro documentation

* change casing for screenshots

* create pro features list, add to header

* Rename Enabling_Deduplication_within_an_Engagement.png to enabling_deduplication_within_an_engagement.png

* Rename Enabling_Deduplication_within_an_Engagement_2.png to enabling_deduplication_within_an_engagement_2.png

* Rename Enabling_Deduplication_within_an_Engagement_3.png to enabling_deduplication_within_an_engagement_3.png

* Rename Enabling_Deduplication_within_an_Engagement_4.png to enabling_deduplication_within_an_engagement_4.png

---------

Co-authored-by: Paul Osinski <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grendel513 grendel513 grendel513 approved these changes

@mtesauro mtesauro mtesauro approved these changes

@dogboat dogboat dogboat approved these changes

@Maffooch Maffooch Maffooch approved these changes

Assignees
No one assigned
Labels
docs ui
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@paulOsinski @grendel513 @mtesauro @dogboat @Maffooch