Skip to content

docs(aa2601): add Enterprise tier and update deployment sizing#1024

Merged
Cmej413 merged 2 commits into
devfrom
carlos-mejia_nwx/2601/system-requirements-update
May 28, 2026
Merged

docs(aa2601): add Enterprise tier and update deployment sizing#1024
Cmej413 merged 2 commits into
devfrom
carlos-mejia_nwx/2601/system-requirements-update

Conversation

@Cmej413
Copy link
Copy Markdown
Contributor

@Cmej413 Cmej413 commented May 27, 2026

Summary

  • Added Enterprise deployment size (48 cores, 128 GB RAM, 3 TB+ SSD, 1 PB+ data threshold)
  • Replaced "Typical Environment" column with Data Threshold volume ranges across all sizing tiers
  • Updated disk recommendations: Small 250 GB, Medium 500 GB, Large 1 TB, Enterprise 3 TB+

Files changed: install/system/requirements.md, install/quickinstall.md

Test plan

  • Verify Enterprise row renders in both Quick Install and System Requirements pages
  • Confirm no broken links or build errors

Generated with AI

Co-Authored-By: Claude Code ai@netwrix.com

Add Enterprise deployment size (48 cores, 128 GB RAM, 3 TB+ SSD) and
replace Typical Environment column with Data Threshold volume ranges.
Updated disk recommendations across all tiers.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@Cmej413 Cmej413 requested a review from a team as a code owner May 27, 2026 21:00
@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/accessanalyzer/2601/install/quickinstall.md

  • Clarity — Line 30: The column header "Data Threshold" is semantically imprecise. "Threshold" implies a single boundary value, but the column lists ranges and capacities. Suggested fix: rename the column to "Data Volume" or "Recommended Data Capacity".
  • Clarity — Lines 32–33: Boundary overlap between rows. "Up to 5 TB" (Small) and "5 TB – 100 TB" (Medium) both include 5 TB, so a reader at exactly 5 TB can't tell which tier applies. Suggested fix: use exclusive ranges — "Up to 5 TB" / "Over 5 TB to 100 TB" / "Over 100 TB to 1 PB" / "Over 1 PB".
  • Clarity / Consistency — Line 35: The values "3 TB+ SSD" and "1 PB+" use a + suffix while the other rows use either ranges or "Up to X". The inconsistent style makes the table harder to scan. Suggested fix: "3 TB or larger SSD" for the Disk cell and "More than 1 PB" for the Data Threshold cell.
  • Completeness — Line 35: The new Enterprise tier is introduced without any narrative guidance on when to choose it over Large, or any note about whether the absolute preflight minimums still apply at this scale. Suggested fix: add a sentence beneath the table noting that Enterprise is for petabyte-scale data sets and that the same preflight minimums apply, or link to deeper sizing guidance.

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

  • Clarity — Line 17: Same "Data Threshold" wording issue as in quickinstall.md. Suggested fix: rename to "Data Volume" or "Recommended Data Capacity" — and keep the wording identical across both files so readers comparing the two tables see the same column name.
  • Clarity — Lines 19–20: Same boundary-overlap problem at 5 TB / 100 TB / 1 PB. Suggested fix: rewrite ranges as exclusive — "Up to 5 TB" / "Over 5 TB to 100 TB" / "Over 100 TB to 1 PB" / "Over 1 PB".
  • Clarity / Consistency — Line 22: Same + suffix inconsistency ("3 TB+ SSD", "1 PB+"). Suggested fix: "3 TB or larger SSD" and "More than 1 PB".
  • Completeness — Line 22: The new Enterprise tier conflicts with the surrounding narrative. Line 13 still tells readers to "Use the Production Recommended specifications for customer-facing or enterprise deployments", which now reads ambiguously — does "enterprise" mean the new tier, or any production deployment? Suggested fix: rewrite the sentence on line 13 to distinguish production deployments from the new Enterprise sizing tier — for example, "Use the recommended specifications below for production deployments. Choose Enterprise for data sets larger than 1 PB."

Summary

8 editorial suggestions across 2 files. The two tables are duplicates and share the same issues — fixing one set of wording in lockstep across both files will keep them consistent. 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

3 issues fixed, 6 skipped across 2 files

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

| docs/accessanalyzer/2601/install/quickinstall.md:26 — Dale: passive-voice | '(enforced by preflight)' is a brief parenthetical past participle, conventional in spec/requirement documentation; rewriting would disrupt the bolded label structure |
| docs/accessanalyzer/2601/install/quickinstall.md:56 — Dale: misplaced-modifiers | 'If running on a hypervisor, configure...' is a standard reduced-clause pattern in technical procedures where the implied subject ('you') is unambiguous |
| docs/accessanalyzer/2601/install/quickinstall.md:460 — Dale: idioms | 'top-to-bottom' is widely understood literal usage describing sequential reading; not a culturally specific idiom |
| docs/accessanalyzer/2601/install/quickinstall.md:484 — Dale: passive-voice | Troubleshooting table cells use participial fragments ('Hostname entered as an IP address', 'Outbound HTTPS blocked', 'UPN format ... entered') describing causes; rewriting to active voice would inflate table cells unnecessarily |
| docs/accessanalyzer/2601/install/system/requirements.md:15 — Dale: passive-voice | '(enforced by preflight)' parenthetical past participle in a bolded label; matches the line 26 quickinstall pattern |
| docs/accessanalyzer/2601/install/system/requirements.md:64 — Dale: misplaced-modifiers | 'When deploying on a virtual machine, configure...' is a standard reduced-clause pattern in technical procedures |

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

@Cmej413 Cmej413 merged commit f2cdb7e into dev May 28, 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