docs: sync fork dev and refresh Learn page statistics - #324
Conversation
parthrohit22
changed the title
ritiksah141
left a comment
ritiksah141
left a comment
There was a problem hiding this comment.
The updates are internally consistent and the mechanics are clean (docs-only, no leftover stale counts, DCO signed, CI green), but the numbers were computed against a dev snapshot from before #277 and #320 merged. Since your fork sync, #277 added 10 new perimeter rules (az_net_018 through az_net_027) plus 10 playbooks, so every headline number is wrong at the merge target:
| Stat | This PR | Actual at dev tip |
|---|---|---|
| Azure security rules | 96 | 106 |
| Remediation playbooks | 96 | 106 per-rule (107 .sh files including the review playbook) |
| HIGH checks | 58 | 67 |
| MEDIUM checks | 32 | 33 |
| Network category bar | 23 (untouched) | 33 |
Compute 5 is the only value that still matches. Related issues that come with the same root cause:
- The category bar widths are scaled to Network 23 as the max, so they need rescaling to 33 = 100% after the rebase.
- The severity boxes do not sum to the headline: 58 + 32 + 4 = 94 vs a headline of 96, because there is no CRITICAL box. The repo has 2 CRITICAL rules. At dev tip the real split is HIGH 67, MEDIUM 33, LOW 4, CRITICAL 2.
- The "4 Compliance frameworks" metric: compliance/frameworks/ now holds 6 JSON files (CIS, NIST CSF, ISO 27001, SOC 2, ENISA PQC, NCSC PQC). If 4 is deliberate (core mapper frameworks only), fine as-is; otherwise update to 6.
This is timing, not process: your sync landed before those merges. The fix is to rebase onto current dev and regenerate: rules and playbooks to 106, HIGH 67, MEDIUM 33, LOW 4, add a CRITICAL 2 severity box, Network bar to 33 with rescaled widths, and the README feature table plus mermaid diagram to 106. Happy to re-review once that lands.
|
@ritiksah141 Rebased onto current dev and recomputed everything against the real tip: rules/playbooks 106, HIGH 67, MEDIUM 33, added the missing CRITICAL box (2), Network bar rescaled to 33. On the "4 vs 6" compliance frameworks question — good catch flagging it rather than guessing. Turns out 4 is deliberate: CI's green on the current head. |
ritiksah141
left a comment
ritiksah141
left a comment
There was a problem hiding this comment.
All good from my side. approving it
Synchronize the fork with upstream dev and refresh derived Learn page and README statistics. Signed-off-by: Parth Rohit <parthrohit60@gmail.com>
The prior sync (bee38ca) computed these numbers before openshield-org#277 and openshield-org#320 merged into dev, so every headline number was stale by the time this PR's base moved. Recomputed directly against current dev tip: - Azure security rules / CLI playbooks: 96 -> 106 - HIGH: 58 -> 67, MEDIUM: 32 -> 33 - Added the missing CRITICAL severity box (2 rules) - the old severity boxes summed to 94 against a 96 headline with no CRITICAL box at all; grid-template-columns updated from repeat(3) to repeat(4) to fit it. - Network category bar: 23 -> 33 (by actual CATEGORY field per rule, not filename prefix - a few non-net-prefixed rules are categorized Network). Rescaled every other category's bar width against the new 33-rule max instead of the old 23. Compute (5) was already current and is unchanged. - Compliance frameworks: 4 -> 6. compliance/frameworks/ holds 6 JSON files (CIS, NIST CSF, ISO 27001, SOC 2, ENISA PQC, NCSC PQC), and api/models/finding.py's FRAMEWORK_FILE_MAP - what the compliance score API actually serves - maps all 6, not 4. The old count wasn't a deliberate 'core mapper only' scoping, just stale. Rebased this branch onto current upstream dev so the fork stays in sync going forward, not just the stats. Signed-off-by: Parth J Rohit <parthrohit60@gmail.com> Signed-off-by: parthrohit22 <parthrohit60@gmail.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2 participants
Summary
Synchronizes
parthrohit22/openshield:devwith the currentopenshield-org/openshield:devand retains the regenerated Learn page and README statistics.Why this PR exists
The hosted Learn page was connected to my fork rather than the upstream repository. As a result, changes merged into
openshield-org/openshielddid not appear on that deployment.I synchronized the fork's
devbranch with upstream to reconcile the divergence. Documentation conflicts were resolved against the current upstreamdevstate, and the statistics refresh produced the final values in this PR.A separate hosting configuration update is needed to connect the deployment to
openshield-org/openshieldso future upstream merges deploy directly.Changes
Validation