Skip to content

docs(navigation): document customizable page layouts on the view pages - #15775

Merged
Maffooch merged 1 commit into
bugfixfrom
docs/page-layouts
Aug 24, 2026
Merged

docs(navigation): document customizable page layouts on the view pages#15775
Maffooch merged 1 commit into
bugfixfrom
docs/page-layouts

Conversation

@blakeaowens

Copy link
Copy Markdown
Contributor

Description

Six view pages (Organization, Asset, Engagement, Test, Finding, and Risk Acceptance) are built from widgets arranged on a grid that users can rearrange, and none of it was documented. The only mentions anywhere in the docs were a changelog line and a bullet describing the administrator switch that restricts customization, which is the one part of the feature a normal user cannot use.

Adds a Customizing Page Layouts page under Navigation, next to Customizing Tables, covering:

  • What a layout is, and that it applies to a page type rather than to one record.
  • The three sources of a layout: shipped with DefectDojo, your own, and shared templates.
  • The Page Layout menu, and the prompt that offers you a personal copy the first time you customize a shipped layout.
  • Editing: moving, resizing, configuring, retitling, removing, and adding widgets, and that changes are saved as you go rather than needing a save step.
  • Creating a layout from scratch or from an existing one.
  • The Manage Layouts actions, in a table.
  • Sharing and defaults, including that publishing a shared template is instance-wide and needs the Page Layout Share permission.
  • Which layout you get when you open a page, in resolution order.
  • Why a widget can be absent from a page, and that this does not alter the saved layout.
  • What a user sees when an administrator has restricted customization.
  • The four shapes of widget in the catalog, and that some widgets appear only when the feature behind them is available.

Also links the Layout Defaults bullet on the Sidebar Menu page through to the new page.

The in-product link

The Page Layouts entry on the Feature Flags page links to https://docs.defectdojo.com/pro/page_layouts/, which nothing serves today, so that link is currently broken. Every other feature flag's documentation link follows the usual content path. The new page aliases /pro/page_layouts/ so the existing link resolves without anyone having to change the product.

Notes for review

The page is text only for now. Screenshots would suit a drag-and-drop feature and can follow.

Worth checking closely: customization is what the feature flag governs, not rendering. Every one of the six pages renders through the grid either way, on a layout that reproduces the page it replaced, so a reader who never customizes anything sees no difference. The page is written to say that and not the reverse.

Test Commands

  • /test all - run all tests

Test Configuration

oss-branch:
oss-username:

Six view pages are built from widgets on a grid, and none of that was
documented. The only traces were a changelog line and a bullet about the
administrator switch that restricts it.

Covers what a layout is, the Page Layout menu, making a first change, editing,
creating from scratch, managing, sharing and defaults, which layout you get on
opening a page, why a widget can be absent, what a restricted instance looks
like, and the four shapes of widget in the catalog.

Aliases /pro/page_layouts/, the address the in-product Feature Flags page
already links to, so that link resolves.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@blakeaowens
blakeaowens requested a review from Maffooch as a code owner August 24, 2026 10:18
@blakeaowens blakeaowens added this to the 3.2.400 milestone Aug 24, 2026
@github-actions github-actions Bot added the docs label Aug 24, 2026
@blakeaowens blakeaowens modified the milestones: 3.2.400, 3.2.300 Aug 24, 2026
@blakeaowens
blakeaowens requested a review from devGregA August 24, 2026 10:25
@Maffooch
Maffooch merged commit 000b5a7 into bugfix Aug 24, 2026
31 checks passed
@Maffooch
Maffooch deleted the docs/page-layouts branch August 24, 2026 14:19
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.

3 participants