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] rename case-sensitive refs so that site builds correctly #11403

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

paulOsinski
Copy link
Contributor

Docs site failed to build on the last PR and I believe this is due to case issues on this page: https://github.com/DefectDojo/django-DefectDojo/actions/runs/12239746474/job/34140911063

To do for a future PR: adjust other image references and file names so that they are all lowercase.

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

DryRun Security Summary

The pull request updates image file names in the DefectDojo Cloud Manager documentation while highlighting security considerations such as firewall configuration, user access management, multi-factor authentication, and external tool usage.

Expand for full summary

Summary:

The code changes in this pull request appear to be focused on updating the image file names in the documentation for the DefectDojo Cloud Manager. While these changes do not directly impact the application's security, there are a few security-related considerations that should be noted:

  1. Firewall Configuration: The documentation discusses how users can configure the firewall settings for their DefectDojo Cloud instances, including the ability to open the firewall to external services or disable it entirely. Ensuring that the firewall is properly configured and that only necessary ports and services are exposed is an important security consideration.

  2. Adding Users to the Cloud Portal: The documentation explains how additional users can be added to the Cloud Portal, allowing them to manage the Cloud Portal and the DefectDojo subscription. It's important to ensure that only authorized users are granted access and that their permissions are properly managed.

  3. Multi-Factor Authentication (MFA): The documentation provides instructions on how to enable MFA for the Cloud Portal login, which is a recommended security best practice to help protect against unauthorized access.

  4. External Tools: The documentation mentions that users can download external tools, such as the DefectDojo CLI, from the Cloud Manager. It's important to ensure that these tools are from trusted sources and that their use is properly secured and monitored.

Files Changed:

  • docs/content/en/cloud_management/using-cloud-manager.md: The changes in this file are primarily focused on updating the file names used in the markdown content to match the actual image file names. While these changes do not directly impact the application's security, the security-related considerations mentioned above should be kept in mind when reviewing the documentation.

Code Analysis

We ran 9 analyzers against 5 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

@mtesauro mtesauro merged commit ade5c15 into DefectDojo:master Dec 11, 2024
71 of 72 checks passed
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.

5 participants