Skip to content

NPSD Health Checks - #1276

Draft
ShameenShahid wants to merge 4 commits into
devfrom
NPSD-Health-Checks
Draft

NPSD Health Checks#1276
ShameenShahid wants to merge 4 commits into
devfrom
NPSD-Health-Checks

Conversation

@ShameenShahid

Copy link
Copy Markdown
Collaborator

No description provided.

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

11 issues fixed, 3 skipped across 1 files

Category Fixes
Contractions 1
NoteThat (rewrite) 1
Dale: idioms 2
Dale: passive-voice 7
Skipped (needs manual review) Reason

| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/nps-d-health-check_1.md:8 — Dale: undefined-acronyms | DR (disaster recovery) is a well-known IT industry term familiar to the sysadmin/security audience |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/nps-d-health-check_1.md:132 — Dale: undefined-acronyms | APIPA is clarified inline as 'APIPA/link-local' and is a standard networking term |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/nps-d-health-check_1.md:180 — Dale: undefined-acronyms | SIEM is a standard, well-known term for the security-analyst audience |

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

@ShameenShahid

Copy link
Copy Markdown
Collaborator Author

@claude fix all issues
@claude help improve the flow of this document

@ShameenShahid ShameenShahid changed the title Add files via upload NPSD Health Checks Jul 29, 2026
@github-actions

github-actions Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Fix complete:

  • Apply the 6 editorial suggestions from the review
  • Improve document flow (H2 groupings mirroring the intro roadmap)
  • Verify changes
  • Commit and push

Summarynps-d-health-check_1.md:

  • Structure / flow — Grouped all the checks under five H2 sections that mirror the intro roadmap (Application, Database, Disaster Recovery (DR), Docker, OS), with the existing procedures nested as H3s beneath them. This fixes the H1→H3 heading-level skip and makes the body match the promised structure. Each group opens with a one-line lead-in so a reader scanning the page knows what it covers.
  • Clarity (NPS-D) — Spelled out the product name on first use: "Netwrix Privilege Secure Discovery (NPS-D), formerly known as SecureONE."
  • Clarity (DR) — Expanded "disaster recovery (DR)" on first use in the intro.
  • Clarity (OS) — Expanded "operating system (OS)" on first use.
  • Clarity (APIPA) — Renamed the heading to "APIPA (Link-Local) Networks" and expanded the acronym in the body ("Automatic Private IP Addressing").
  • Structure (SIEM link) — Removed the leading space inside the link parentheses so the URL renders correctly and passes the broken-link check.
  • Completeness (DR reference) — The dangling "Reference: DR Scripts Setup Tracking documentation." line pointed to a document that doesn't exist anywhere in the docs repo, so there was no valid link to add. Per the review's alternative, it was removed. If that article does exist, reply with @claude and its URL and I'll add a proper link back in.

@github-actions

github-actions Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Fix complete:

  • Restructure with H2 category groupings (Application, Database, DR, Docker, OS) and improve flow
  • Spell out NPS-D and DR acronyms on first use
  • Resolve dangling "DR Scripts Setup Tracking" reference
  • Fix leading space in the SIEM link
  • Clarify the APIPA Networks heading
  • Verify, commit, and push

Summary — all six editorial suggestions applied, plus flow improvements, in docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/nps-d-health-check_1.md:

  • Structure / flow — Added five H2 groupings (## Application Checks, ## Database Checks, ## Disaster Recovery (DR) Checks, ## Docker Checks, ## OS Checks) that mirror the intro roadmap, and nested the existing H3 procedures beneath them. This fixes the H1→H3 level skip and reorders the interleaved sections so the body follows the order the intro promises. Each H2 opens with a one-line summary of what that group verifies, and the intro now tells the reader to work through the groups in order.
  • Clarity (NPS-D) — First use now reads "Netwrix Privilege Secure Discovery (NPS-D), formerly known as SecureONE."
  • Clarity (DR) — Expanded to "disaster recovery (DR)" on first use in the intro; the section heading is now "Disaster Recovery (DR) Checks."
  • Clarity (APIPA) — Heading is now "APIPA (Link-Local) Networks," with the full "Automatic Private IP Addressing" expansion kept in the body.
  • Completeness (DR reference) — Removed the dangling "Reference: DR Scripts Setup Tracking documentation." line, which pointed to no destination. If a target article exists, let me know the URL and I'll add a proper link instead.
  • Structure (SIEM link) — Removed the leading space inside the parentheses so the URL immediately follows (.

I also expanded "OS" to "operating system (OS)" on first use and trimmed the trailing space in the title frontmatter for consistency.

- Add H2 category groupings (Application, Database, DR, Docker, OS) and nest
  existing H3 procedures so the body matches the intro roadmap and no heading
  levels are skipped
- Spell out NPS-D (Netwrix Privilege Secure Discovery) and DR (disaster
  recovery) on first use; expand OS and APIPA
- Remove the dangling 'DR Scripts Setup Tracking' reference (no destination)
- Remove the leading space inside the SIEM link
- Clarify the APIPA Networks heading

Co-Authored-By: Claude <[email protected]>
@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

1 issues fixed, 3 skipped across 1 files

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

| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/nps-d-health-check_1.md:63 — Dale: passive-voice | 'If log forwarding isn't configured' is an idiomatic conditional; an active rewrite would be forced and less natural. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/nps-d-health-check_1.md:100 — Dale: passive-voice | 'Confirm that backup and restore functions are configured and running' describes a state to verify; rewriting to active would change the intended meaning. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/nps-d-health-check_1.md:63 — Dale: undefined-acronyms | SIEM is a well-known security-industry acronym for this security/sysadmin audience (Security Information and Event Management); consistent with the acronym allowlist for well-known standards. |

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

@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/nps-d-health-check_1.md

  • Clarity — Line 24: The s1 status / s1 nodes commands are the first use of the s1 command, but it isn't introduced until line 75 ("use the s1 CLI helper"). A newer user won't know that s1 is the NPS-D command-line helper on first encounter. Suggested fix: introduce it on first use, e.g., "confirm all services and nodes are up using the s1 NPS-D command-line helper:".
  • Clarity — Line 21 / Line 75: Version notation is inconsistent — line 21 reads "NPS-D 2.22 and higher" while line 75 reads "NPS-D 2.22.x and higher". Suggested fix: use one form consistently (e.g., "2.22.x and higher") so it matches the "2.21.x and earlier" phrasing used in the same comparisons.
  • Structure — Line 12: "The checks are grouped in the same order the intro lists them" refers to the document itself as "the intro," which reads awkwardly and forces the reader to look back up. Suggested fix: state the order directly, e.g., "The sections below follow the same order: application, database, disaster recovery, Docker, and OS."

Summary

3 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.

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.

2 participants