docs: add DefectDojo Pro Report Builder guides (UI, API, LLM)#15008
Open
skywalke34 wants to merge 3 commits into
Open
docs: add DefectDojo Pro Report Builder guides (UI, API, LLM)#15008skywalke34 wants to merge 3 commits into
skywalke34 wants to merge 3 commits into
Conversation
Replace the outdated report builder pages with a Pro-focused multi-page section: - Report Builder UI walkthrough (Themes, Blocks, Templates, Generated Reports) - API automation guide: create, run, poll, and download reports, with a stdlib Python script - LLM-assisted authoring guide with a paste-in prompt - Open-source report builder page (build, run, retrieve; no saved templates/history) - Rewrite the section landing page with OSS-vs-Pro orientation Adds UI screenshots captured from the Pro Report Builder. Authored by T. Walker - DefectDojo
…formerly Products) nomenclature - Repoint inbound links from the removed using_the_report_builder URL: the FAQ and intro-to-findings pages now link to the Report Builder section landing, and the open-source new-user checklist links to the OSS report builder page. - Use "Assets (formerly Products)" / "Organizations (formerly Product Types)" wording in the Pro Report Builder pages, and correct the filter-discovery endpoints to /api/v2/assets/ and /api/v2/organizations/. Authored by T. Walker - DefectDojo
The theme builds the bottom-of-page Prev/Next links from all regular pages in the top-level metrics_reports section ordered by weight. The low weights on the new Report Builder pages collided with the Pro Metrics and Dashboards pages, scrambling the sequence (e.g. the API page's Next went to "Custom Dashboard Tiles"). Reweight the Report Builder pages and MCP Server so the reading order flows Pro Metrics -> Report Builder -> Automating Reports with the API -> Building Reports with an LLM -> MCP Server, with the open-source page last. Sidebar grouping and order are unchanged. Authored by T. Walker - DefectDojo
valentijnscholten
approved these changes
Jun 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds DefectDojo Pro Report Builder documentation, replacing the outdated report builder pages under
metrics_reports/reports/:New pages are gated to the DefectDojo Pro docs version via the
audienceflag; the open-source page stays on the Open Source version. Inbound links to the removed pages were repointed, and the Metrics & Reports prev/next ordering was corrected. Content and the API/field references were verified against thedojo-proreporting code and a live tenant; screenshots were captured from the Report Builder UI.