Docs updates and QA - Jan 2025

[paulOsinski]

Retry of 11524 to exclude non-docs files.

• QA and reformatting: creating a report
• Beta UI article
• Additional info on Jira removal
• Switching SVGs for PNG
• additional info on disconnecting from Jira, template notifications

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

[dryrunsecurity]

DryRun Security Summary

The pull request involves comprehensive documentation updates for DefectDojo, covering topics such as the Beta UI, Jira integration, report generation, and application architecture, with a focus on improving user experience and providing detailed guidance while maintaining security considerations.

Expand for full summary

Summary:

The code changes in this pull request primarily involve updates to the documentation for the DefectDojo application security tool. The changes cover a range of topics, including the new Beta UI for DefectDojo Pro, the Jira integration, report generation, and general application architecture documentation.

From an application security perspective, the changes do not appear to introduce any immediate security vulnerabilities. The documentation updates focus on improving the user experience, providing more detailed guidance, and enhancing the integration between DefectDojo and other tools like Jira. These improvements can have a positive impact on the overall security posture of organizations using DefectDojo.

However, it is important to note that while the changes themselves do not raise any security concerns, the documentation should still be reviewed carefully to ensure that it does not contain any sensitive information that should not be publicly disclosed. Additionally, the security of any external integrations, such as the Jira integration, should be thoroughly reviewed and tested to mitigate potential risks.

Files Changed:

1. docs/content/en/open_source/archived_docs/usage/models.md: The changes involve updating the documentation with a new PNG image and adding an exclude_search front-matter property.
2. docs/content/en/customize_dojo/notifications/configure_system_notifs.md: The changes provide more detailed information about configuring system-wide notifications in DefectDojo, including the use of system-wide email, Slack, or Microsoft Teams channels.
3. docs/content/en/api/api-v2-docs.md: The changes enhance the API documentation, providing more information about authentication, available client libraries, and examples of using the API.
4. docs/content/en/about_defectdojo/ui_pro_vs_os.md: The changes introduce the new Beta UI for DefectDojo Pro, highlighting the new features and functionality.
5. docs/content/en/open_source/installation/architecture.md: The change involves replacing an SVG image with a PNG image in the application architecture documentation.
6. docs/content/en/share_your_findings/jira_integration/connect_to_jira.md: The changes focus on documenting the process of disconnecting from Jira and the associated security considerations.
7. docs/content/en/share_your_findings/pro_reports/working_with_generated_reports.md: The changes provide more guidance on managing reports, including using them as templates, re-running reports, and deleting old or unused reports.
8. docs/content/en/share_your_findings/jira_integration/troubleshooting_jira.md: The changes update the documentation to provide troubleshooting guidance for the Jira integration feature in DefectDojo.
9. docs/content/en/share_your_findings/jira_integration/add_jira_to_product.md: The changes enhance the documentation for configuring the Jira integration at the product level within DefectDojo, including options for customizing the integration.

Code Analysis

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

View PR in the DryRun Dashboard.

[mtesauro]

Approved

[cneill]

I think the links in ui_pro_vs_os.md will require a leading / to point to the right location since they'd otherwise be interpreted as relative to the en/about_defectdojo directory