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.

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

Docs maintenance - v2.41.4 #11484

Merged
merged 19 commits into from
Jan 2, 2025
Merged

Conversation

paulOsinski
Copy link
Contributor

@paulOsinski paulOsinski commented Dec 31, 2024

Docs site maintenance / changes:

  • Reorganize sections in sidebar for ease of navigation
  • Add emojis to sidebar to delimit sections (this is temporary and I will figure out how to add SVGs in a future PR, to match Pro UI icons)
  • Fix broken links
  • Fix terms / reorganize Jira, Working With Findings
  • Add back Product Hierarchy image as png (linking out to svgs from source is not supported in this theme :( )
  • Remove problematic articles from search results

[sc-9635]
[sc-9267]
[sc-9268]

@github-actions github-actions bot added the docs label Dec 31, 2024
Copy link

dryrunsecurity bot commented Dec 31, 2024

DryRun Security Summary

The GitHub Pull Request focuses on updating the DefectDojo application's documentation with various improvements, including cosmetic changes, expanded guidance, and organizational updates, without introducing any apparent security vulnerabilities.

Expand for full summary

Summary:

The code changes in this GitHub Pull Request are primarily focused on updating the documentation for the DefectDojo application, an open-source vulnerability management tool. The changes cover a wide range of topics, including API documentation, changelogs, cloud management, connectivity troubleshooting, and various integration and configuration options.

From an application security perspective, the changes do not introduce any obvious security vulnerabilities. The updates are mostly related to improving the clarity, organization, and user experience of the documentation, which is an important aspect of secure software development.

However, the application security engineer should still review the changes carefully to ensure that the documentation does not inadvertently expose any sensitive information, introduce potential security misconfigurations, or fail to emphasize important security-related features and best practices.

Files Changed:

  1. docs/content/en/api/_index.md: The title of the API documentation page has been updated to include an emoji, which is a cosmetic change that does not raise any security concerns.
  2. docs/content/en/changelog/_index.md: The title of the Changelog page has been updated to include an emoji, which is also a cosmetic change.
  3. docs/content/en/cloud_management/additional-cloud-instance.md: This file has been updated to include a new section on reviewing and submitting a request for an additional cloud instance, which is a reasonable documentation improvement.
  4. docs/content/en/cloud_management/connectivity-troubleshooting.md: The documentation for connectivity troubleshooting has been expanded to provide more detailed guidance, which is a positive change.
  5. docs/content/en/connecting_your_tools/_index.md: The title of the "Connect Your Tools" page has been updated to include an emoji, which is a cosmetic change.
  6. docs/content/en/cloud_management/_index.md: The title of the "DefectDojo Cloud Manager" page has been updated to include an emoji, which is a cosmetic change.
  7. docs/content/en/cloud_management/using-cloud-manager.md: The documentation for the DefectDojo Cloud Manager has been expanded to include more details on various features and functionality, including the ability to enable multi-factor authentication (MFA), which is a positive security enhancement.
  8. docs/content/en/connecting_your_tools/import_scan_files/_index.md: The title of the "Import Scans" page has been changed to "How To Import Data", which is a documentation improvement.
  9. docs/content/en/connecting_your_tools/connectors/_index.md: The weight property of the "Connectors" section has been updated, which is a minor organizational change.
  10. docs/content/en/connecting_your_tools/parsers/_index.md: The title of the "Supported Reports" page has been changed to "Supported Report Types", which is a documentation improvement.
  11. docs/content/en/connecting_your_tools/parsers/api/_index.md: The weight property of the "API Pull" parser page has been updated, which is a minor organizational change.
  12. docs/content/en/connecting_your_tools/import_intro.md: The title of the "Import Methods" page has been changed to "Import Method Comparison", which is a documentation improvement.
  13. docs/content/en/connecting_your_tools/parsers/generic_findings_import.md: The documentation for the "Generic Findings Import" feature has been expanded to provide more details on the supported data formats and attributes, which is a positive change.
  14. docs/content/en/connecting_your_tools/parsers/file/_index.md: The weight property of the "Files" parser page has been updated, which is a minor organizational change.
  15. docs/content/en/customize_dojo/dashboard_notifications/Introduction_dashboard.md: The title of the "Introduction to Dashboard Features" page has been changed to "DefectDojo Main Dashboard", and the content has been restructured to provide more detailed information on the various dashboard components and configuration options.
  16. docs/content/en/customize_dojo/_index.md: A new Markdown file has been added to the "customize_dojo" directory, titled "\ud83d\udc65 Management & Customization", which covers topics related to dashboards and user access.
  17. docs/content/en/customize_dojo/dashboard_notifications/_index.md: The title of the "Set Up Your Dashboard" page has been change

Code Analysis

We ran 9 analyzers against 30 files and 0 analyzers had findings. 9 analyzers had no findings.

View PR in the DryRun Dashboard.

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

Copy link
Contributor

@cneill cneill left a comment

Choose a reason for hiding this comment

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

Just a few small things I noticed

@Maffooch Maffooch merged commit a99f02d into DefectDojo:master Jan 2, 2025
72 of 73 checks passed
@paulOsinski paulOsinski deleted the xmas-docs-updates branch January 2, 2025 22:37
farsheedify pushed a commit to farsheedify/django-DefectDojo that referenced this pull request Jan 3, 2025
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants