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.41.1: docs maintenance #11413

Merged
merged 8 commits into from
Dec 19, 2024
Merged

Conversation

paulOsinski
Copy link
Contributor

@paulOsinski paulOsinski commented Dec 11, 2024

  • Cleanup articles to make them easier to edit as .md files
  • Fix heading levels so that navigation sidebar works correctly
  • Change .md files to use relative paths, rather than absolute URLs (makes broken links less likely)
  • Merge several Connectors articles to better suit theme & navigation

[sc-9265]
[sc-9264]

@github-actions github-actions bot added the docs label Dec 11, 2024
@paulOsinski paulOsinski marked this pull request as draft December 11, 2024 22:59
Copy link

dryrunsecurity bot commented Dec 11, 2024

DryRun Security Summary

The pull request focuses on comprehensive documentation improvements for the DefectDojo application security platform, covering areas such as tool integration, user permissions, security finding management, and advanced feature configuration to enhance user understanding and platform usability.

Expand for full summary

Summary:

The code changes in this pull request are primarily focused on updating and improving the documentation for the DefectDojo application security platform. The changes cover a wide range of topics, including the integration of external security tools, the management of user permissions and roles, the handling of security findings, and the overall usage and functionality of the platform.

From an application security perspective, the changes do not introduce any direct security vulnerabilities or concerns. Instead, the updates aim to provide users with clearer and more comprehensive guidance on how to effectively utilize the various security-related features and capabilities of DefectDojo.

The documentation improvements cover important areas such as:

  1. Integrating external security tools through the use of connectors, API pipelines, and the Universal Importer.
  2. Managing user permissions, roles, and access controls to ensure the appropriate level of access and security.
  3. Handling and managing security findings, including importing, reimporting, and tracking vulnerabilities over time.
  4. Configuring and using advanced features like AB testing, tracking parameters, and hardcoded constants.

Overall, these documentation updates are a positive step for the security and usability of the DefectDojo platform, as they help users better understand and leverage the application's security-focused functionality.

Files Changed:

  1. docs/content/en/about_defectdojo/new_user_checklist.md: Updated links and guidance for various DefectDojo features and functionality.
  2. docs/content/en/connecting_your_tools/connectors/_index.md: Updated the title and weight of the "API Connectors" page.
  3. docs/content/en/connecting_your_tools/connectors/about_connectors.md: Added a note about Connectors being a pro-feature.
  4. docs/content/en/connecting_your_tools/connectors/add_edit_connectors.md: Added a note about Connectors being a pro-feature and provided more detailed instructions.
  5. docs/content/en/connecting_your_tools/connectors/connectors_tool_reference.md: Clarified that Connectors are a pro-feature and provided more detailed setup instructions.
  6. docs/content/en/connecting_your_tools/connectors/manage_operations.md: Introduced the "Discover" and "Sync" operations for ConnectorsS.
  7. docs/content/en/connecting_your_tools/connectors/manage_records.md: Added a new section on managing records in DefectDojo.
  8. docs/content/en/connecting_your_tools/import_scan_files/_index.md: Updated the weight of the file.
  9. docs/content/en/connecting_your_tools/external_tools.md: Added a note about the Universal Importer and Dojo-CLI being pro-features.
  10. docs/content/en/connecting_your_tools/import_intro.md: Provided more detailed information about the different import methods in DefectDojo.
  11. docs/content/en/connecting_your_tools/import_scan_files/import_scan_ui.md: Updated the description of the "Engagements" feature.
  12. docs/content/en/connecting_your_tools/parsers/_index.md: Updated the weight of the file.
  13. docs/content/en/connecting_your_tools/import_scan_files/api_pipeline_modelling.md: Provided guidance on using the /reimport and /import API endpoints.
  14. docs/content/en/connecting_your_tools/import_scan_files/smart_upload.md: Updated the title and provided more details on the Smart Upload feature.
  15. docs/content/en/connecting_your_tools/import_scan_files/using_reimport.md: Provided more detailed information on the Reimport functionality.
  16. docs/content/en/user_management/about_perms_and_roles.md: Updated the file name and provided more detailed information on user permissions and roles.
  17. docs/content/en/user_management/_index.md: Updated the title and description of the "User Management" section.
  18. docs/content/en/user_management/create_user_group.md: Provided more detailed guidance on creating and managing user groups.
  19. docs/content/en/user_management/configure_sso.md: Provided instructions for configuring SAML and OAuth-based SSO

Code Analysis

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

View PR in the DryRun Dashboard.

@paulOsinski paulOsinski marked this pull request as ready for review December 11, 2024 23:19
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

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

@Maffooch Maffooch merged commit f1d6d02 into DefectDojo:master Dec 19, 2024
71 of 73 checks passed
paulOsinski added a commit to paulOsinski/django-DefectDojo that referenced this pull request Dec 23, 2024
* qa connectors: merge articles, fix links

* qa 'connecting tools': labels, weights, content

* qa user mgmt docs: weights, content, links

* fix broken links

* fix upgrade notes typo

---------

Co-authored-by: Paul Osinski <[email protected]>
Co-authored-by: Cody Maffucci <[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.

5 participants