Skip to content

docs(auditor): refresh Nutanix AHV add-on documentation for 10.9#1201

Open
TheNewCat777 wants to merge 2 commits into
devfrom
feature/nutanix-ahv-addon-docs-refresh
Open

docs(auditor): refresh Nutanix AHV add-on documentation for 10.9#1201
TheNewCat777 wants to merge 2 commits into
devfrom
feature/nutanix-ahv-addon-docs-refresh

Conversation

@TheNewCat777

Copy link
Copy Markdown
Contributor

Update the Nutanix AHV add-on topics to match the current product:

  • Prerequisites: drop AOS 5.x version references, obsolete Windows versions (8.1 / Server 2012 R2), and Auditor 9.9 note; require Windows Server 2019+ and note default UDP 514.
  • Overview: renumber the "How it works" list (previously skipped 5-6); replace install.ps1 / settings.xml references with the configuration wizard; fix "NAuditor -compatible" typo.
  • Install: add step numbers to H2 headings so they map to the top-level roadmap; merge Prism Element and CLI procedures into a single ncli procedure; split Prism Central procedure into "Configure the Syslog Server" and "Set the Logging Level" subsections; describe all six wizard steps (Nutanix Prism connection, Netwrix Auditor connection, Active Directory credentials, monitoring plan, general settings, completion) with real field names and defaults; note that configuration files live in C:\ProgramData\Add-on for Nutanix AHV.
  • Monitored events: replace inline superscript-like footnote digits with a Source column (Syslog / Events API) and move Host add/remove clarifications into readable bullets below the table.
  • Troubleshooting: add checks for the Windows service (NwNxIntrSvc) and the log directory; remove the outdated multi-instance workaround (multiple Prism servers per host are not supported).
  • Delete deployment.md — the settings.xml-based deployment scenarios no longer apply and the page was unreferenced.

Update the Nutanix AHV add-on topics to match the current product:

- Prerequisites: drop AOS 5.x version references, obsolete Windows
  versions (8.1 / Server 2012 R2), and Auditor 9.9 note; require
  Windows Server 2019+ and note default UDP 514.
- Overview: renumber the "How it works" list (previously skipped 5-6);
  replace install.ps1 / settings.xml references with the configuration
  wizard; fix "NAuditor -compatible" typo.
- Install: add step numbers to H2 headings so they map to the top-level
  roadmap; merge Prism Element and CLI procedures into a single ncli
  procedure; split Prism Central procedure into "Configure the Syslog
  Server" and "Set the Logging Level" subsections; describe all six
  wizard steps (Nutanix Prism connection, Netwrix Auditor connection,
  Active Directory credentials, monitoring plan, general settings,
  completion) with real field names and defaults; note that
  configuration files live in C:\ProgramData\Add-on for Nutanix AHV\.
- Monitored events: replace inline superscript-like footnote digits
  with a Source column (Syslog / Events API) and move Host add/remove
  clarifications into readable bullets below the table.
- Troubleshooting: add checks for the Windows service (NwNxIntrSvc)
  and the log directory; remove the outdated multi-instance
  workaround (multiple Prism servers per host are not supported).
- Delete deployment.md — the settings.xml-based deployment scenarios
  no longer apply and the page was unreferenced.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@TheNewCat777 TheNewCat777 requested a review from a team as a code owner July 7, 2026 15:54
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/auditor/10.9/addon/nutanixahv/install.md

  • Clarity — Lines 36–37: This cross-reference tells the reader to specify the monitoring plan in the Monitoring Plan and Monitoring Plan Item fields, but the wizard fields in Step 4 (lines 175–176) are actually labeled Netwrix Auditor Plan and Netwrix Auditor Plan Item. A reader following the pointer won't find fields with those names. Suggested fix: match the labels — "specify this monitoring plan in the Netwrix Auditor Plan and Netwrix Auditor Plan Item fields in the add-on configuration wizard."
  • Completeness — Lines 124–128 (Step 3, "Install the Add-On"): The steps say "Navigate to your add-on package," "Unzip the Add-On to a desired folder," then "Run the installation package." But overview.md (line 83) describes the package as a single MSI installer (Netwrix_Auditor_Addon_NutanixAHV.msi). If the download is one MSI, "unzip" is confusing; if it's a ZIP that contains the MSI, that isn't stated. Suggested fix: clarify what the reader downloads — e.g., "Extract the add-on ZIP archive" then "Run Netwrix_Auditor_Addon_NutanixAHV.msi" — so the file names match the overview.
  • Clarity — Lines 143–145 (Step 4): The wizard is introduced here as "the configuration wizard" that "opens in your default web browser" and can be launched "from the Start menu shortcut," but overview.md (lines 51, 105) refers to the same tool as Wizard.exe. Use one consistent name across both files so the reader knows they are the same tool. Suggested fix: name it once (for example, Wizard.exe / the configuration wizard) and reuse that term everywhere.
  • Structure — Lines 122–191: The new "## Step 3" and "## Step 4" sections each contain their own "Step 1 –Step 6/7 –" sequences, so the reader sees a "Step" inside a "Step." This mirrors the existing Prism procedures, but the nesting can disorient a reader scanning for "Step 4." Consider a distinct label for the inner sequence (for example, wizard "screens" or "pages" for the Step 4 wizard) to separate the two levels.

docs/auditor/10.9/addon/nutanixahv/overview.md

  • Clarity — Lines 51–53: "launches Wizard.exe" names the configuration tool differently from install.md, which calls it "the configuration wizard" launched from a Start menu shortcut. Align the naming with install.md so both topics clearly describe the same tool. (Same underlying issue as the install.md note above — fixing one should settle both.)

docs/auditor/10.9/addon/nutanixahv/monitoredevents.md

  • No issues found. The rebuilt table adds a clear Source column, and the "Notes on Host events" list replaces the previous superscript footnotes with self-contained, readable notes.

docs/auditor/10.9/addon/nutanixahv/troubleshooting.md

  • No issues found. The new checklist items (configuration wizard, service name NwNxIntrSvc, log path) are concrete and fit the surrounding troubleshooting flow.

docs/auditor/10.9/addon/nutanixahv/collecteddata.md

  • No issues found. The change only updates the image path from 10.7 to 10.9.

Summary

4 editorial suggestions across 2 files (install.md, overview.md); 3 files reviewed with no issues. The main theme is cross-file consistency for the new MSI/wizard install flow: the wizard field labels, the package format (MSI vs. ZIP), and the wizard's name should match between install.md and overview.md. 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

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

28 issues fixed, 6 skipped across 6 files

Category Fixes
Contractions 7
Removed filler 1
Substitutions 3
FollowTheStepsTo (rewrite) 1
Idioms (rewrite) 2
OxfordComma (rewrite) 2
Dale: idioms 1
Dale: passive-voice 7
Dale: positional-references 1
Dale: wordiness 3
Skipped (needs manual review) Reason
docs/auditor/10.9/addon/nutanixahv/install.md:23 — Netwrix.Idioms 'Leverage Integration API' is the literal bolded name of a product UI toggle in Auditor, not prose. Rewording would misname the control.
docs/auditor/10.9/addon/nutanixahv/troubleshooting.md:12 — Netwrix.Idioms 'Leverage Integration API' is the literal bolded name of a product UI setting in Auditor, not prose. Rewording would misname the control.
docs/auditor/10.9/addon/nutanixahv/deployment.md:0 — Dale: n/a File listed in changed-files.txt does not exist on disk
docs/auditor/10.9/addon/nutanixahv/install.md:74 — Dale: passive-voice 'Verify the server was created' — active rewrite risks changing meaning; low confidence
docs/auditor/10.9/addon/nutanixahv/install.md:23 — Dale: n/a Lowercase list-item start 'ensure' is a capitalization typo, not covered by a Dale rule
docs/auditor/10.9/addon/nutanixahv/collecteddata.md:11 — Dale: wordiness 'For that,' filler is minor and rewrite risks altering intended flow; low value

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

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