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

2.42.0 docs updates #11524

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

paulOsinski
Copy link
Contributor

@paulOsinski paulOsinski commented Jan 7, 2025

  • QA and reformatting: creating a report
  • Beta UI article
  • Additional info on Jira removal
  • Switching SVGs for PNG

[sc-9270]
[sc-9639]
[sc-9762]

@github-actions github-actions bot added the docs label Jan 7, 2025
Copy link

dryrunsecurity bot commented Jan 7, 2025

DryRun Security Summary

The provided text summarizes documentation updates for the DefectDojo application, focusing on improvements to Jira integration, report generation, and various documentation enhancements across multiple files.

Expand for full summary

Summary:

The provided code changes involve various updates to the documentation for the DefectDojo application, including improvements to the Jira integration, report generation, and other features. The changes do not introduce any direct security vulnerabilities, but there are a few security-related aspects that should be considered:

  1. Jira Integration: The documentation updates related to the Jira integration provide important information on how to properly configure and troubleshoot the integration between DefectDojo and Jira. Ensuring a secure and reliable Jira integration is crucial for effectively managing and tracking security findings across the two platforms.

  2. Report Generation: The changes to the documentation for the Report Builder feature highlight the importance of maintaining appropriate access controls and data handling procedures when generating reports that may contain sensitive security-related information. Proper sanitization and validation of custom content in the reports is also necessary to prevent potential injection attacks.

  3. Documentation Updates: While the changes are primarily focused on improving the documentation, it's important to review any updates to ensure that they do not inadvertently introduce security-related issues, such as the inclusion of malicious content in the documentation or changes that could impact the overall security posture of the application.

Files Changed:

  1. docs/content/en/share_your_findings/jira_integration/_index.md: The title of the documentation page has been updated to better reflect the content, which is about sending DefectDojo findings to Jira.

  2. docs/content/en/open_source/installation/architecture.md: The inline SVG image for the architecture diagram has been replaced with a regular image file.

  3. docs/content/en/open_source/archived_docs/usage/models.md: The SVG image has been replaced with a PNG image, and a new metadata field exclude_search: true has been added.

  4. docs/content/en/about_defectdojo/ui_pro_vs_os.md: The documentation has been updated to introduce the new "Beta UI" feature in the DefectDojo Pro version, which includes several enhancements and new dashboards.

  5. docs/content/en/share_your_findings/jira_integration/connect_to_jira.md: The documentation has been updated to provide information on how to properly disable or remove a Jira integration from DefectDojo.

  6. docs/content/en/share_your_findings/pro_reports/working_with_generated_reports.md: The title and content of the documentation have been updated to focus on using reports as templates and re-running existing reports.

  7. docs/content/en/share_your_findings/jira_integration/troubleshooting_jira.md: The title and description of the documentation have been updated to focus on troubleshooting issues with the Jira integration.

  8. docs/content/en/share_your_findings/jira_integration/add_jira_to_product.md: The documentation has been updated to provide more detailed information on the various Jira integration settings for a DefectDojo product.

  9. docs/content/en/share_your_findings/pro_reports/using_the_report_builder.md: The documentation for the Report Builder feature has been reorganized and expanded, including the addition of a "Report Widget Index" section.

Code Analysis

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

View PR in the DryRun Dashboard.

@paulOsinski paulOsinski changed the title 2.42.0 docs updates (WIP) 2.42.0 docs updates Jan 7, 2025
@paulOsinski paulOsinski marked this pull request as ready for review January 7, 2025 21:45
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.

1 participant