Skip to content

docs(navigation): document sidebar presets - #16649

Open
blakeaowens wants to merge 2 commits into
devfrom
docs/sidebar-presets
Open

blakeaowens wants to merge 2 commits into
devfrom
docs/sidebar-presets

Conversation

@blakeaowens

Copy link
Copy Markdown
Contributor

Description

Documents Sidebar Presets, a DefectDojo Pro feature shipping with the paired Pro PR: named sets of hidden sidebar entries that are shared or personal, duplicated like a page layout, and one shared preset as the instance default.

  • New page docs/content/navigation/PRO__sidebar_presets.md: what a preset is, hide never deny (a preset only subtracts from what roles, flags and the license show; direct links and the API keep working; Home and All Settings are always shown), building a preset (section cards, cascading groups, the live preview, new and stale entries), sharing and the instance default (also on Layout Defaults, and the lock), picking a preset on User Profile, the five permissions, and the API surface.
  • PRO__sidebar.md: the new UI Defaults entry, the Layout Defaults sentence now naming sidebar presets, a pointer from "Turning entries off" (flags remove for everyone; a preset hides for some), and a Related link.
  • PRO__landing_page.md: a landing page hidden by the chosen preset falls back to Home, and the profile page says so.

English only; the language copies are generated.

Test results

Docs only: no code changes. The headings the in-app walkthrough links to are hidden-never-denied, sharing-and-the-instance-default and picking-a-preset.

Documentation

This PR is the documentation.

Checklist

  • Make sure to rebase your PR against the very latest dev.
  • Features/Changes should be submitted against the dev.
  • Give a meaningful name to your PR, as it may end up being used in the release notes.
  • Your code is flake8 compliant.
  • Your code is python 3.11 compliant.
  • If this is a new feature and not a bug fix, you've included the proper documentation in the docs at https://documentation.defectdojo.com as part of this PR.
  • Model changes must include the necessary migrations in the dojo/db_migrations folder.
  • Add applicable tests to the unit tests.
  • Add the proper label to categorize your PR.

Named sets of hidden sidebar entries in DefectDojo Pro: hide never deny, building a preset,
sharing and the instance default, picking one on User Profile, the permissions and the API.
Linked from the sidebar page and the landing page docs.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@blakeaowens blakeaowens added this to the 3.5.0 milestone Oct 30, 2026
@blakeaowens
blakeaowens requested a review from Maffooch as a code owner October 30, 2026 23:43
@github-actions github-actions Bot added the docs label Oct 30, 2026
…ile pick

One name for the feature: the Settings row, the page and the breadcrumb now read Sidebar Presets,
like the flag, the permissions and this page. Sidebar Preset View also lets a user pick a preset on
User Profile, since every read of the presets needs it.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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.

1 participant