Skip to content

docs(walkthroughs): document the area tours and why findings close and reopen - #16382

Merged
blakeaowens merged 2 commits into
devfrom
docs/why-findings-close-and-reopen
Oct 17, 2026
Merged

blakeaowens merged 2 commits into
devfrom
docs/why-findings-close-and-reopen

Conversation

@blakeaowens

@blakeaowens blakeaowens commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Description

Documents the first wave of in-app tours, in two pages.

In-App Walkthroughs (docs/content/navigation/PRO__walkthroughs.md): a new "Tours by area" section. The page described only the App Tour; the section lists the eleven area tours in one table, with where the lightbulb lists each one, what it covers, and who sees it (the feature and permission each is gated on, and the steps a missing permission skips). The tours are Why Findings Close and Reopen; Organizations, Assets, Engagements and Tests; Finding Statuses, SLAs and Risk Acceptance; The Findings List; Exporting Findings; API Access; Reports; SSO and Login; Classic Jira or the Jira Connector; Locations; and Upstream Connectors.

Reimport (docs/content/import_data/import_intro/reimport.md): a new "Why Findings Close and Reopen" section, for the most common reimport question, a Finding that keeps closing and coming back. It says where the evidence is:

  • the Import History on the Test page counts the Findings each Reimport closed and reactivated;
  • the note a Reimport writes on a Finding it closes or reopens names the scan type, and a Finding closed by hand has neither note.

It then covers the three causes behind most cases:

  • a partial scan reimported into a Test that holds a full one, with Close Old Findings on;
  • a Finding closed by hand while the scanner still reports it, which the next Reimport reopens (False Positive, Out of Scope and Risk Accepted are the statuses Reimport never reopens);
  • a Finding whose location moved, when the line number or file path is part of how Reimport matches that tool's Findings.

It ends with Do Not Reactivate for a scanner that is triaged elsewhere. The section links only to anchors already on the same page (Actions, Reimport Deduplication, Reopen Findings), and the reimport tour's last card links to its anchor, #why-findings-close-and-reopen.

Every other tour card links to a docs section that already exists; each of those anchors was checked on docs.defectdojo.com.

English only: the language copies of the docs are translated automatically.

Testing

Docs only. Each reimport claim was checked against the reimport code on dev (Close Old Findings on by default for Reimport, the two note texts, the statuses Reimport never reopens, Do Not Reactivate). Each row of the tours table was checked against the tour's definition: its pages, its feature flag and permission, and its per-step gates. The Hugo site was not built locally.

🤖 Generated with Claude Code

Adds a section to the Reimport page on the commonest reimport question:
where the evidence is (Import History's closed and reactivated counts,
and the note each Reimport writes on a Finding it closes or reopens),
the three causes behind most cases (a partial scan reimported into a
Test holding a full one, a Finding closed by hand while the scanner
still reports it, and a Finding whose location moved), and Do Not
Reactivate for a scanner triaged elsewhere.
@blakeaowens
blakeaowens requested a review from Maffooch as a code owner October 16, 2026 20:51
@blakeaowens blakeaowens added this to the 3.4.200 milestone Oct 16, 2026
@github-actions github-actions Bot added the docs label Oct 16, 2026
The In-App Walkthroughs page described only the App Tour. A new Tours by
area section lists the eleven area tours: where the lightbulb lists each
one, what it covers, and who sees it (the feature and permission each is
gated on, and the steps a missing permission skips).
@blakeaowens blakeaowens changed the title docs(reimport): explain why findings close and reopen after a reimport docs(walkthroughs): document the area tours and why findings close and reopen Oct 17, 2026
@blakeaowens
blakeaowens added this pull request to the merge queue Oct 17, 2026
Merged via the queue into dev with commit a788c16 Oct 17, 2026
32 checks passed
@blakeaowens
blakeaowens deleted the docs/why-findings-close-and-reopen branch October 17, 2026 03:12
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