Skip to content

Update AccessAnalyzer disk requirements for scan queue sizing - #1369

Merged
mckibbenc merged 2 commits into
devfrom
mckibbenc/accessanalyzer-disk-requirements
Aug 12, 2026
Merged

Update AccessAnalyzer disk requirements for scan queue sizing#1369
mckibbenc merged 2 commits into
devfrom
mckibbenc/accessanalyzer-disk-requirements

Conversation

@mckibbenc

@mckibbenc mckibbenc commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Small/Medium recommended disk increases and /var/lib minimum now accounts for scan queue space scaling with deployment size.

Small/Medium recommended disk increases and /var/lib minimum now
accounts for scan queue space scaling with deployment size.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@mckibbenc
mckibbenc requested a review from a team as a code owner August 11, 2026 18:11
@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/accessanalyzer/2601/install/system/requirements.md

  • Completeness — Line 37: The footnote introduces "deployment size" as a numeric value ("a deploy size of 2"), but the document never defines it. The Deployment Sizing table on lines 17–22 uses named tiers (Small, Medium, Large, Enterprise), not numbers, so a reader who picked "Medium" has no way to know what number to multiply by 32 GB. Suggested fix: either map the tiers to their numeric deployment sizes in the Deployment Sizing table, or restate the formula in terms the reader already has — for example, "The scan queue reserves 32 GB per deployment size unit. Small deployments (size 1) need 32 GB; a size 2 deployment needs 64 GB."

  • Completeness — Line 33: The table column is titled Minimum Free Space, but 52 GB is only the minimum for the smallest deployment. A reader scanning the table will provision 52 GB and hit a preflight failure on a larger deployment. Suggested fix: change the cell to "52 GB minimum (scales with deployment size — see note)" so the table doesn't read as a fixed value.

  • Clarity — Line 33: 52 GB appears without derivation, while the note explains the components separately (20 GB baseline + 32 GB per deployment size). The reader has to reverse-engineer that 52 = 20 + 32. Suggested fix: state it in the note — "The 52 GB minimum is the 20 GB baseline plus 32 GB for a deployment size of 1."

  • Structure — Line 37: ** is used as a footnote marker, but ** is bold syntax in Markdown and isn't a convention used elsewhere in this doc set. Netwrix content patterns call for an admonition here. Suggested fix: replace the ** marker and paragraph with a :::note block placed directly after the table, and drop the ** from the table cell:

    :::note
    The scan queue reserves disk space in `/var/lib`, so the required size depends on your deployment size. The scan queue needs 32 GB per deployment size unit, in addition to the 20 GB baseline. A deployment size of 2 needs 64 GB for the scan queue, so `/var/lib` requires 84 GB total.
    :::
  • Completeness — Lines 19–20: The Recommended Disk values increased to 300 GB and 600 GB, but the new scan queue requirement raises a question the document doesn't answer: do these recommended totals already include the /var/lib scan queue reservation, or is the scan queue space additive? A reader sizing a VM needs to know whether 300 GB covers everything. Suggested fix: add a sentence after the Deployment Sizing table — "Recommended Disk values include the /var/lib scan queue reservation described in Disk Space Requirements."

  • Clarity — Line 37: The paragraph mixes "deployment size" and "deploy size" for the same concept in consecutive sentences. Suggested fix: use "deployment size" throughout.

Summary

6 editorial suggestions across 1 file. Vale and Dale issues are auto-fixed separately.


What to do next:

Comment @claude on this PR followed by your instructions to get help:

  • @claude fix all issues — fix all editorial issues
  • @claude help improve the flow of this document — get writing assistance
  • @claude explain the voice issues — understand why something was flagged

You can ask Claude anything about the review or about Netwrix writing standards.

Automated fixes are only available for branches in this repository, not forks.

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

4 issues fixed, 2 skipped across 1 files

Category Fixes
Dale: passive-voice 1
Dale: wordiness 3
Skipped (needs manual review) Reason

| docs/accessanalyzer/2601/install/system/requirements.md:49 — Dale: wordiness | 'compatible' repeats three times and 'Debian stable releases' appears twice, but the second sentence carries the author's rationale for why Debian qualifies; trimming it risks dropping intended meaning |
| docs/accessanalyzer/2601/install/system/requirements.md:62 — Dale: passive-voice | 'Required for Kubernetes networking' is a terse table-cell fragment; rewriting to active voice would make the column inconsistent with adjacent cells |

Ask @claude on this PR if you'd like an explanation of any fix.

@mckibbenc
mckibbenc merged commit 2611252 into dev Aug 12, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants