Skip to content

docs(psirt): publishing advisories to the advisory site - #16881

Draft
devGregA wants to merge 4 commits into
DefectDojo:devfrom
devGregA:docs/psirt-advisory-site
Draft

devGregA wants to merge 4 commits into
DefectDojo:devfrom
devGregA:docs/psirt-advisory-site

Conversation

@devGregA

Copy link
Copy Markdown
Contributor

Summary

These pages describe a DefectDojo Pro feature that ships in an upcoming release. Please merge this with that release and not before, so the docs do not describe something readers cannot use yet.

DefectDojo Pro's PSIRT module can publish an authored advisory to a public advisory site at advisory.defectdojo.com. This change documents that, in text only.

PSIRT Settings (docs/content/psirt/settings.md) gains an Advisory Site section:

  • what publishing needs (the PSIRT: Advisory Site feature flag, which DefectDojo turns on per instance, and a license that includes advisory publishing)
  • the publisher profile fields: display name, namespace, contact, requested slug and the CSAF aggregator choice
  • that DefectDojo staff review and activate a publisher before anything goes public
  • the statuses the card shows (Not Sent, Pending, Active, Suspended) and what each means for publishing and for pages already on the site
  • that the display name, namespace and slug are fixed once the publisher is active
  • what happens to public pages when a subscription stops including advisory publishing
  • that an airgapped instance cannot use the feature

Advisories (docs/content/psirt/advisories.md) gains a "Publishing to the advisory site" section:

  • what the advisory site is
  • the "Publish to the advisory site" switch, and that it is part of what reviewers approve
  • the six readiness checks and what to do about each
  • what the public document contains and what stays out
  • what happens at publish, the states of the Advisory Site delivery row, and how a failed send is retried
  • how a revision reaches the site
  • Withdraw: what it does, who can do it, that it cannot be undone from the product, and that an advisory on the site cannot be deleted until it is withdrawn
  • an API example for reading the delivery state and for withdrawing, on /api/v2/

Corrected, because the page no longer matched the product:

  • Preflight runs seven checks. The CSAF export check builds and validates the document and reports a problem as a warning, where the page said it was not implemented. The new advisory site check is listed.
  • The "Flag errata" action is removed. The section is now "Revisions" and says a correction is made by revising and publishing a new version.
  • Branding captured with a snapshot is removed. "Snapshots" now says a snapshot is the frozen content of a published version.

The PSIRT index page and the Feature Flags page each get one line that points at the new section. Translated copies of these pages are not touched.

🤖 Generated with Claude Code

devGregA and others added 4 commits November 13, 2026 20:32
…ttings

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Add the advisory site section to the Advisories page: the switch, the
readiness checks, what becomes public, delivery states, revisions,
withdraw and the API. Remove the errata action and snapshot branding,
which the product does not have.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…ture flags page

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…pension

Use the delivery row's real labels, state the retry schedule exactly,
describe preflight's seven checks, say what a suspension and a lapsed
subscription do to public pages, and name the feature flag.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@devGregA devGregA added the docs label Nov 14, 2026

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