Repository navigation
docs: document the Remediation report [OD-936] - #2789
claudiacodacy wants to merge 2 commits into
Conversation
Adds a Remediation report section to Security and risk management: each figure and the rule behind it, the 90-day trend calculation, the open backlog, and the filters. Notes on Customize deadlines that changing an SLA changes the report's past results. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
|
Overall readability score: 54.61 (🟢 +0.06)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
The Overview and Remediation reports move from security/index.md to a new security/reports.md, matching the product's Reports tab. index.md keeps the general SRM content and a short Reports section that keeps the #dashboard anchor the product links to. Internal links to the moved sections now point at reports.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull Request Overview
Two issues should be addressed before merging: add the final Remediation report screenshot and preserve or redirect legacy Overview anchors moved from index.md. The SPA Reports documentation link also remains unupdated, leaving an acceptance criterion incomplete. No complex-file or coverage risks were identified.
About this PR
- Update the SPA Reports documentation link to point to
security/reports/before merging.
Test suggestions
- Verify the new Reports page is registered in mkdocs navigation and links from the Security and risk management index resolve.
- Verify migrated Overview anchors and updated links resolve to the Reports page and its sections.
- Verify the Remediation report documentation covers metrics, SLA rules, 90-day trend calculation, backlog categories, and filters.
- Verify the documentation includes a final Remediation report screenshot and terminology matches the shipped UI.
- Verify the SPA Reports link points to security/reports/.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify the new Reports page is registered in mkdocs navigation and links from the Security and risk management index resolve.
2. Verify migrated Overview anchors and updated links resolve to the Reports page and its sections.
3. Verify the Remediation report documentation covers metrics, SLA rules, 90-day trend calculation, backlog categories, and filters.
4. Verify the documentation includes a final Remediation report screenshot and terminology matches the shipped UI.
5. Verify the SPA Reports link points to security/reports/.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
| In addition, on these pages, you can [share filtered views of findings](findings.md#sharing-filtered-view), [export findings as a CSV file](findings.md#exporting-the-security-item-list), and [review severity rules and integration settings](findings.md#reviewing-settings) | ||
|
|
||
| ## Overview {: id="dashboard"} | ||
| ## Reports {: id="dashboard"} |
There was a problem hiding this comment.
🟡 MEDIUM RISK
Preserve the removed Overview section anchors on index.md or provide equivalent redirects so existing deep links remain valid.
|
|
||
| To open the report, select an organization from the top navigation bar, select **Security and risk** on the left navigation sidebar, open the **Reports** tab, and select **Remediation**. | ||
|
|
||
| <!-- TODO: verify — add a screenshot of the Remediation report (images/security-risk-management-remediation-report.png) once OD-958 ships the final layout --> |
There was a problem hiding this comment.
🟡 MEDIUM RISK
Add the final Remediation report screenshot before merging, or retain this TODO only while the PR remains draft as stated in the description.
Adds the Remediation report to the Security and risk management docs: what each figure means, the rules behind it, how the 90-day trend is calculated, the open backlog, and the filters. Requested in OD-936; the rules come from the project spec, P-OD-442.
Draft until the report ships. The page describes the finished report. Merge it once OD-958 and the rest of P-OD-442 are live.
What changed
The product's Security and risk management tabs are Reports, Findings, Dependencies, App scanning and Container scanning. Every tab had its own page except Reports, so both reports now get one.
docs/security/reports.md(new, innav:afterindex.md): the Overview report, moved fromindex.md, and the new Remediation report. Remediation subsections have fixed anchors (#remediation-report,-rules,-closed,-weekly,-trend,-backlog,-filters).docs/security/index.md: keeps the general SRM content (supported categories, scan types, languages). A short Reports section keeps{: id="dashboard"}, because the product's page header links tosecurity/#dashboard, and links to both reports. The topic card now points at the Reports page.findings.md,dependencies.md,app-scanning.md: links that pointed atindex.md#dashboardor at the moved panels now point atindex.mdorreports.md.findings.mdalso says, under Customize deadlines, that changing an SLA changes the report's past results.No redirect is needed, because
index.mdkeeps its URL. Panel anchors such as#open-findings-historyand#activity-historynow live onsecurity/reports/, so outside links to them onsecurity/land on the page without scrolling to the panel.Sources
MttrBySla/utils.ts,MttrTrend.tsx, merged in #3182): the current week is left out, the line is fitted through weekly means weighted by closes, the trend is steady under 10% of the SLA or 1 day, and there's no trend with fewer than 5 closes or fewer than 3 in either half of the window.masteryet: the Mean by week chart, the Scan types filter, and filters carrying into Open in Findings.Before merging
TODO: verifymarker inindex.md)security/reports/(it links tosecurity/#dashboardtoday, which still works)👀 Live preview
Preview deployment for this branch:
security/reports/🚧 To do
🤖 Generated with Claude Code