Skip to content

docs: DefectDojo Pro Customizable Dashboards (dashboard_v2)#15111

Merged
Maffooch merged 5 commits into
DefectDojo:devfrom
skywalke34:docs/pro-custom-dashboards
Jul 1, 2026
Merged

docs: DefectDojo Pro Customizable Dashboards (dashboard_v2)#15111
Maffooch merged 5 commits into
DefectDojo:devfrom
skywalke34:docs/pro-custom-dashboards

Conversation

@skywalke34

Copy link
Copy Markdown
Contributor

Description

Adds documentation for the new DefectDojo Pro Customizable Dashboards (dashboard_v2) — the per-user, widget-and-layout dashboard system — and reworks the Dashboards section to cleanly separate Open Source from Pro.

What's new

  • Customizable Dashboards (PRO__custom_dashboards.md) — concepts (layouts, widgets, the widget catalog, sharing) plus a full UI walkthrough with screenshots.
  • Automating Dashboards with the API (PRO__custom_dashboards_api.md) — discover the widget catalog, create and update layouts, set a default, share with a team, and render widget data over the REST API, with a complete lifecycle script.
  • Building Dashboards with an LLM (PRO__custom_dashboards_llm.md) — a self-contained prompt pattern for having an LLM design, create, and verify dashboards via the API.
  • Reworked the Dashboards section landing (_index.md) into an Open Source vs. Pro comparison plus a "where to go next" guide.

Cleanup

  • Removed the obsolete about_custom_dashboard_tiles.md (the old singular Pro "tiles" dashboard, superseded by dashboard_v2).
  • Trimmed Introduction_dashboard.md to focus on the OSS Main Dashboard.
  • Pointed the top-nav "Metrics & Reports" link back at the OSS Main Dashboard page so it lands on a page with the full left side menu, consistent with every other top-nav section.
  • Minor link/reference touch-ups in a few neighboring pages.

Notes

  • Customizable Dashboards are a DefectDojo Pro (beta) feature; the new pages are marked audience: pro and carry a beta-enablement note.
  • Docs-only change. Previewed locally with hugo server.

Document the new Pro customizable dashboards (layouts + widget catalog,
beta behind the dashboard_v2 feature flag): concepts + UI walkthrough,
the /api/v2/dashboards/ REST API with a full lifecycle script, and a
paste-in LLM prompt. Rework the dashboards index for OSS-vs-Pro, point
the OSS Main Dashboard page's Pro section at the new docs, remove the
obsolete custom-tiles page, and repoint inbound links to it.

Authored by T. Walker - DefectDojo
…n ordering

Authored by T. Walker - DefectDojo
…LM prompt copy button

Authored by T. Walker - DefectDojo
The top-nav Metrics & Reports link targeted the dashboards section
index (_index.md) — a chapter landing rendered without the left side
menu. Restore it to the introduction_dashboard leaf page so the nav
lands on a page with the full sidebar and version selector, consistent
with every other top-nav item.

Authored by T. Walker - DefectDojo
@Maffooch Maffooch requested a review from paulOsinski June 30, 2026 05:39
@Maffooch Maffooch requested review from Jino-T and blakeaowens June 30, 2026 16:30
@Maffooch Maffooch added this to the 3.1.0 milestone Jun 30, 2026

@mtesauro mtesauro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@Maffooch Maffooch merged commit 8f42916 into DefectDojo:dev Jul 1, 2026
148 of 149 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