Skip to content

Removed Drain nodes instructions and enhance clarity in update OS doc…#1200

Open
ShameenShahid wants to merge 10 commits into
devfrom
Shameen-patch-2-OS-update
Open

Removed Drain nodes instructions and enhance clarity in update OS doc…#1200
ShameenShahid wants to merge 10 commits into
devfrom
Shameen-patch-2-OS-update

Conversation

@ShameenShahid

Copy link
Copy Markdown
Collaborator

…umentation

Removed Drain nodes instructions as node drain and changing of manager node is not required to apply OS updates. This can cause instability in environment and result in P1 issue.

Also improved clarity in the update OS documentation for appliances.

…umentation

Removed Drain nodes instructions as node drain and changing of manager node is not required to apply OS updates. This can cause instability in environment and result in P1 issue. 

Also improved clarity in the update OS documentation for appliances.
@ShameenShahid ShameenShahid requested a review from a team as a code owner July 6, 2026 23:44
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

12 issues fixed, 1 skipped across 1 files

Category Fixes
Contractions 2
Substitutions 1
Dale: passive-voice 3
Dale: positional-references 6
Skipped (needs manual review) Reason

| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:14 — Dale: undefined-acronyms | NPSD is a product-specific acronym used without definition, but the correct expansion is uncertain; spelling it out incorrectly would introduce error, so skipped. |

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 — fix all editorial issues

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Fix complete:

  • Spell out NPSD acronym on first use
  • Move cluster-specific failover note out of the intro into the Cluster use case
  • Add corrective action to the Docker 29.x.x version note
  • Make the 29.x.x note consistent across both use cases (as a :::note)
  • Fix self-referential "go to Step 3" loop in Single-Node use case
  • Fix sudp typo in both use cases
  • Fix "each node" wording in the Single-Node use case
  • Fix title-case "Install Package Updates"
  • Verify, commit, and push

Summary — all 9 editorial suggestions applied to docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:

  • NPSD acronym — expanded to "Netwrix Privilege Secure Discovery (NPSD)" on first use.
  • Structure — moved the cluster-specific failover note out of the general best-practice intro and into the "Use Case: Cluster In-Place" section, so the intro stays focused on the shared recommendation.
  • Docker 29.x.x note — standardized both use cases to an identical :::note admonition and added the missing corrective action ("do not proceed with the update; contact Netwrix support before continuing").
  • Self-reference loop — Single-Node "If the command doesn't return any results, then go to Step 3" corrected to "go to Step 4" (the step that adds the holds).
  • sudp typo — fixed to sudo in both use cases; the command would have failed as written.
  • "each node" — changed to "the node" in the Single-Node use case (Steps 2 and 3).
  • Casing — "Install Package Updates" changed to sentence case, "Install package updates."

One item to confirm: the corrective action I added for the Docker 29.x.x check ("do not proceed with the update; contact Netwrix support before continuing") is a conservative, safe default since the exact remediation wasn't specified in the review. If there's a specific downgrade procedure or support path you'd prefer readers follow, reply with @claude and I'll update it.

- Spell out NPSD as Netwrix Privilege Secure Discovery on first use
- Move cluster-specific failover note from the intro into the Cluster use case
- Add corrective action and consistent :::note for the Docker 29.x.x check in both use cases
- Fix self-referential 'go to Step 3' loop in the Single-Node use case
- Fix sudp typo (sudo) in both use cases
- Change 'each node' to 'the node' in the Single-Node use case
- Use sentence case for 'Install package updates'

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

3 issues fixed, 3 skipped across 1 files

Category Fixes
Contractions 2
Dale: positional-references 1
Skipped (needs manual review) Reason

| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:17 — Dale: wordiness | 'There are different options to fit your environment or downtime tolerance.' is slightly wordy, but any concise rewrite risked shifting the meaning of 'fit your environment or downtime tolerance', so left as-is. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:53 — Dale: passive-voice | 'SSH to the node being updated' uses a passive participle, but rewriting could obscure that this refers to the specific node in the current iteration; ambiguous, so skipped. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:22 — Dale: wordiness | 'This is a guide to updating the OS...' is somewhat wordy, but tightening it risked altering the intended framing; skipped to preserve meaning. |

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

- Remove duplicated H1 heading and stray repeated title line
- Spell out NPSD on first use and fix intro grammar/comma
- Fix corrupted MongoDB replication command (SecureONESecureONE, broken line wrap)
- Fix `sudp apt` typo (both use cases)
- Fix circular step reference (single-node Step 3 pointed to itself)
- Fix `s1 node` -> `s1 nodes` command typo
- Remove erroneous possessive apostrophe (nodes' status)
- Standardize NOTE formatting and step-title sentence case
- Align config-file note and Docker-version step across both use cases
- Spell out numbers and clean trailing whitespace

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Fixed the editorial issues in updateosonappliances.md and pushed to this branch. Summary of changes:

Correctness / typos

  • Fixed the sudp aptsudo apt typo in both use cases.
  • Repaired the corrupted MongoDB replication command in the Cluster section (SecureONESecureONE duplication and a broken line wrap) to match the correct command used later in the doc.
  • Fixed the s1 nodes1 nodes command typo.
  • Fixed a circular step reference in the Single-Node section (Step 3 said "go to Step 3"; now points to Step 4, the add-holds step).

Structure / clarity

  • Removed the duplicated H1 heading and the stray repeated title line at the top.
  • Spelled out Netwrix Privilege Secure Discovery (NPSD) on first use.
  • Removed the erroneous possessive apostrophe in "nodes' status".
  • Made the config-file note and the Docker-version step consistent across both use cases, and used "on the node" (singular) in the Single-Node section.
  • Standardized step titles to sentence case, spelled out small numbers ("three Docker packages"), and cleaned up trailing whitespace.

I rebased onto the latest branch state and merged with the concurrent auto-fix commits, keeping the :::note admonitions those introduced.

Note: Vale/Dale style issues are auto-fixed separately by the vale-autofix workflow on this PR.

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

3 issues fixed, 3 skipped across 1 files

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

| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:89 — Dale: passive-voice | 'Result if reboot is required' / 'Result if reboot not required' are conventional output-label fragments; making them active would break the parallel labeling and risk changing meaning. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:100 — Dale: misplaced-modifiers | 'Monitor for the node to complete rebooting with.' has an awkward trailing 'with' that leads into the following code block; the intended phrasing is ambiguous, so fixing it could change meaning. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:13 — Dale: wordiness | 'There are different options to fit your environment or downtime tolerance.' introduces a list; a tighter rewrite would shift 'your' to 'different' and slightly alter meaning. |

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

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

2 issues fixed, 3 skipped across 1 files

Category Fixes
Dale: idioms 1
Dale: wordiness 1
Skipped (needs manual review) Reason

| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:80 — Dale: passive-voice | 'If prompted to replace a configuration file or setting' is passive, but the actor (apt/the system) is ambiguous; an active rewrite risks naming the wrong subject and changing meaning. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:166 — Dale: passive-voice | Same 'If prompted to replace...' construction as line 80; skipped for the same ambiguous-actor reason. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:100 — Dale: misplaced-modifiers | 'Monitor for the node to complete rebooting with.' has a dangling 'with' referring to the following code block; multiple valid rewrites exist and any change could disrupt the intended command-block structure. |

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

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

2 issues fixed, 2 skipped across 1 files

Category Fixes
Dale: wordiness 2
Skipped (needs manual review) Reason

| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:100 — Dale: wordiness | 'Monitor for the node to complete rebooting with.' is grammatically broken (trailing 'with' points to the following code block), but the intended phrasing is ambiguous — not confidently a style-rule fix. |
| docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md:89 — Dale: passive-voice | 'Result if reboot is required' reads as passive but is an idiomatic, standard technical state label; rewriting would reduce clarity. |

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

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/privilegesecurediscovery/2.22/administration/onpremmaintenance/updateosonappliances.md

  • Structure — Lines 46–58: "SSH to the node you're updating." is immediately followed by Step 1 ("Confirm the Docker version on each node") and Step 2 ("On each node, confirm that the following three Docker packages have a hold on them"). After the reader has SSHed into a single node, instructing them to act "on each node" is contradictory. Suggested fix: either move the version/hold checks before the "SSH to the node" line and frame them as a one-time check across the cluster, or reword Steps 1–3 to target "this node" so they match the single node the reader just connected to.

  • Completeness — Lines 58–62 (and mirrored at lines 145–150 in the single-node case): "If the command doesn't return any results, then go to Step 3." points to the step that already comes next, and the doc never states what to do when the command does return results. The reader can't tell whether existing holds mean they should skip the "add holds" step. Suggested fix: "If the command lists the three packages, they're already held — skip to Step 4 (Download update package information). If it returns no results, continue to Step 3 to add the holds." (Adjust the step numbers accordingly for the single-node case.)

  • Clarity — Line 100: "Monitor for the node to complete rebooting with." The trailing "with." before the code block reads awkwardly. Suggested fix: "Monitor the node until it finishes rebooting:" (the code block then follows naturally).

  • Completeness — Line 28: "For a 3-node clustered Netwrix Privilege Secure Discovery (NPSD) deployment, a failover is optional." introduces "a failover" without context. A newer reader won't know what failover this refers to or when they would perform it. Suggested fix: add a short clause identifying the failover (for example, "a swarm-leader failover is optional") or link to the relevant procedure.

  • Consistency — Lines 123–125 (Step 10, cluster case) and lines 183–185 (Step 8, single-node case): the final status check is written as an inline bullet (- s1 status; s1 nodes), while the parallel checks introduced elsewhere in this PR — such as Step 8 in the cluster case (lines 115–119) — use a fenced code block. Suggested fix: format these final status checks as fenced code blocks for consistency with the other command examples.

Summary

5 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