Skip to content

EPP Changes to be committed for 2605 Client release:#877

Merged
jth-nw merged 6 commits into
devfrom
eppminor20260508
May 11, 2026
Merged

EPP Changes to be committed for 2605 Client release:#877
jth-nw merged 6 commits into
devfrom
eppminor20260508

Conversation

@krzysztofstaszalek
Copy link
Copy Markdown
Collaborator

modified:   docs/endpointprotector/admin/cap_module/capai.md
modified:   docs/endpointprotector/admin/cap_module/newoutlook.md
modified:   docs/endpointprotector/index.md
modified:   docs/endpointprotector/install/migrationprocedure/clientupgradediagram.webp
modified:   docs/endpointprotector/install/migrationprocedure/faq.md
modified:   docs/endpointprotector/install/migrationprocedure/migrationguide.md

	modified:   docs/endpointprotector/admin/cap_module/capai.md
	modified:   docs/endpointprotector/admin/cap_module/newoutlook.md
	modified:   docs/endpointprotector/index.md
	modified:   docs/endpointprotector/install/migrationprocedure/clientupgradediagram.webp
	modified:   docs/endpointprotector/install/migrationprocedure/faq.md
	modified:   docs/endpointprotector/install/migrationprocedure/migrationguide.md
bturlea
bturlea previously approved these changes May 8, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

Auto-Fix Summary

86 issues fixed, 13 skipped across 5 files

Category Fixes
Contractions 1
FirstPerson (rewrite) 1
OxfordComma (rewrite) 1
Dale: exclamatory-sentences 1
Dale: misplaced-modifiers 1
Dale: passive-voice 64
Dale: positional-references 6
Dale: undefined-acronyms 2
Dale: wordiness 9
Skipped (needs manual review) Reason
docs/endpointprotector/install/migrationprocedure/migrationguide.md:558 — Netwrix.OxfordComma False positive — the comma after 'Statement' ends an introductory clause ('As defined in the Client Supportability Statement,'); 'obsolete and discontinued' is a two-item conjunction in the main clause, not a series of three items requiring an Oxford comma
docs/endpointprotector/admin/cap_module/newoutlook.md:22 — Dale: passive-voice left 'unless the EPP agent is running' and similar passive states inside the warning admonition; rewriting risked changing meaning of the JavaScript-variable behavior description
docs/endpointprotector/admin/cap_module/newoutlook.md:84 — Dale: passive-voice manifest-file description ('At the core of any Office Add-in is the manifest file') uses inversion that's clearer than alternatives; not strictly passive
docs/endpointprotector/install/migrationprocedure/faq.md:28 — Dale: misplaced-modifiers 'Once patched to 2604, the result is functionally equivalent…' has an arguable dangling participle but rewriting risks changing meaning; subject 'the result' is contextually understood
docs/endpointprotector/install/migrationprocedure/faq.md:75 — Dale: xy-slop 'cross-check the count, not just the success status' is a contrast statement, not strictly an x-is-not-y/x-is-z form; meaning would shift if rewritten
docs/endpointprotector/install/migrationprocedure/faq.md:91 — Dale: undefined-acronyms SCIM is a recognized industry standard for identity provisioning; flagging risked over-correcting given the rule's exclusion of well-known IT acronyms
docs/endpointprotector/install/migrationprocedure/faq.md:99 — Dale: undefined-acronyms FQDN is a well-known networking acronym; rule excludes well-known IT industry standards
docs/endpointprotector/install/migrationprocedure/faq.md:188 — Dale: undefined-acronyms ELS for PHP is a license component name where 'ELS' functions as part of the proper-noun product name; defining mid-sentence would change reading
docs/endpointprotector/install/migrationprocedure/migrationguide.md:116 — Dale: undefined-acronyms CRM is a well-known industry term (Customer Relationship Management); skipped per rule guidance on industry-standard acronyms
docs/endpointprotector/install/migrationprocedure/migrationguide.md:618 — Dale: undefined-acronyms MDM is a well-known IT industry acronym (Mobile Device Management) similar to GPO/MFA listed in exclusions
docs/endpointprotector/install/migrationprocedure/migrationguide.md:718 — Dale: undefined-acronyms SCCM is a well-known Microsoft enterprise tool acronym; treating as industry standard
docs/endpointprotector/admin/cap_module/capai.md:73 — Dale: minimizing-difficulty 'integrates seamlessly' describes product behavior, not a user task being minimized; rewriting risked altering meaning of the conclusion
docs/endpointprotector/index.md:28 — Dale: minimizing-difficulty 'seamless management and enforcement' is a marketing-tone borderline case but doesn't minimize a user task; left intact

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

Auto-Fix Summary

7 issues fixed, 12 skipped across 5 files

Category Fixes
OnceUsage (rewrite) 1
Dale: passive-voice 3
Dale: positional-references 1
Dale: wordiness 2
Skipped (needs manual review) Reason

| docs/endpointprotector/admin/cap_module/capai.md:11 — Dale: passive-voice | 'become increasingly integrated' rewrite would alter the introductory framing of the AI integration trend |
| docs/endpointprotector/admin/cap_module/capai.md:70 — Dale: passive-voice | 'triggered by the URL' is part of a video description bullet narrative; alternative phrasings change technical meaning |
| docs/endpointprotector/admin/cap_module/capai.md:73 — Dale: minimizing-difficulty | 'integrates seamlessly' is video conclusion marketing wording; not clearly a difficulty-minimizing claim about a user task |
| docs/endpointprotector/admin/cap_module/capai.md:122 — Dale: minimizing-difficulty | 'integrates seamlessly' is video conclusion marketing wording; not clearly a difficulty-minimizing claim about a user task |
| docs/endpointprotector/admin/cap_module/newoutlook.md:195 — Dale: positional-references | 'as described in previous chapter' uses temporal/sequential 'previous' rather than spatial 'above'/'below'; not clearly a violation |
| docs/endpointprotector/admin/cap_module/newoutlook.md:211 — Dale: positional-references | 'as described in the previous chapter' uses temporal/sequential 'previous' rather than spatial 'above'/'below'; not clearly a violation |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:384 — Dale: misplaced-modifiers | 'Use for example Google's public DNS' has misplaced 'for example'; multiple valid rewrites possible without clear winner |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:454 — Dale: positional-references | 'click Reload above the status column' refers to a literal UI position, not document content |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:537 — Dale: positional-references | 'still below 5.9.4.3' uses 'below' as a numerical comparison, not a positional document reference |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:538 — Dale: positional-references | 'still below 5.9.4.3' uses 'below' as a numerical comparison, not a positional document reference |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:158 — Dale: positional-references | 'disk space is below 30%' uses 'below' as a numerical comparison, not a positional document reference |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:728 — Dale: passive-voice | 'is rate-limited' is a technical description; rewrite would change meaning or add ambiguity |

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

@jth-nw jth-nw temporarily deployed to development May 8, 2026 15:29 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/endpointprotector/admin/cap_module/capai.md

  • Clarity — Line 71: "The test submitted credit card (CC) patterns to each AI platform for validation. An AI engine generated the sample data. The CAP policy automatically blocks any transaction containing CC data." Tense shifts mid-bullet from past ("submitted", "generated") to present ("blocks"). Other bullets in this list are consistent. Suggested fix: "The CAP policy was configured to automatically block any transaction containing CC data." — or shift the first two sentences to present ("The test submits..." / "An AI engine generates..."). Match the convention used by the other bullets in this list.
  • Clarity — Line 114: "The test simulates an HR use case in which Copilot enhances employment contract templates without sensitive data to improve formatting and presentation quality." The modifier "without sensitive data" is ambiguous — it could attach to the templates or to "enhances". Suggested fix: "The test simulates an HR use case in which Copilot enhances employment contract templates that contain no sensitive data, improving formatting and presentation quality."

docs/endpointprotector/admin/cap_module/newoutlook.md

  • Structure — Lines 34, 39, 42, 45, 67, 70: The "Requirements" intro on line 34 says "you must address three dependencies collectively," but the list that follows contains five items — and worse, two items are both numbered 4. ("Host Validation Part and Icons" and "Standard EPP Content Aware Protection Policy"). Markdown will renumber them automatically, but the source is now incorrect and brittle. Suggested fix: Update the intro to "you must address the following dependencies collectively" (drop the count), and renumber the second 4. to 5. and the existing 5. to 6..
  • Completeness — Lines 30 and 40: "You need customer portal access to download the EPP content*." The trailing asterisk appears to mark a footnote, but no footnote text exists anywhere in the file. Either drop the asterisk or add the corresponding note (e.g., explaining how to request portal access). Suggested fix: Remove the * from both occurrences, or add a :::note admonition describing how to obtain customer portal access.
  • Structure — Lines 77–79: A :::warning Important block ("Host these URLs correctly on your server and ensure they're accessible via the internet to enable required functionalities for the add-in.") is added at the end of the Requirements section, but the same warning already exists at lines 143–145 inside the "Pre-configuring add-in (manifest.xml)" section. The duplicate appears before the URLs it references are even introduced. Suggested fix: Remove the new admonition at lines 77–79 — the existing one at line 143 is in the correct context (immediately after the URL configuration steps).
  • Clarity — Line 96: "The Microsoft add-in validator requires this." The pronoun "this" has no clear antecedent — the heading is "Define icons location" but a reader scanning the section may not connect "this" to the icons. Suggested fix: "The Microsoft add-in validator requires the icon URLs."
  • Clarity — Line 186: "Netwrix doesn't recommend the manual deployment method because you must repeat it for each user account. Use this method for pilot phases, troubleshooting, or feature proofs of concept (PoCs)." The juxtaposition reads as contradictory — first don't use it, then use it. Suggested fix: "Use this method only for pilot phases, troubleshooting, or feature proofs of concept (PoCs)."

docs/endpointprotector/index.md

  • Completeness — Line 40: The version was updated to "Current EPP Client & EE Version (2605)" and line 39 already shows server version 2604, but the introductory paragraph at line 35 (unchanged) still says "Netwrix Endpoint Protector 2602 is now the current supported version" and "Netwrix recommends upgrading to version 2602 or later." The intro now contradicts the table. Suggested fix: Update line 35 to reference 2604 (the current server version) instead of 2602 so the supportability statement matches the version table.

docs/endpointprotector/install/migrationprocedure/faq.md

  • Clarity — Line 41: "If none of these steps resolves it, contact Netwrix Support with the server logs from /var/log/epp/." Subject–verb agreement: with a plural noun ("steps"), modern usage prefers "none ... resolve". Suggested fix: "If none of these steps resolve the issue, contact Netwrix Support with the server logs from /var/log/epp/."
  • Clarity — Line 144: "Generate a test transfer that the system should detect and confirm whether it appears in CAP logs." The clause structure is ambiguous — "confirm" could attach to "the system should" or to the reader. Suggested fix: "Generate a test transfer that the system should detect, then confirm whether it appears in CAP logs."
  • Consistency — Lines 238–241: The decommissioning checklist mixes tenses. Item 1 uses present ("All endpoints successfully communicate with 2510."), items 2–4 use past ("You verified...", "You satisfied...", "You created..."). Suggested fix: Make all four items consistent — either all present ("You verify all integrations.", "You satisfy compliance...", "You create a full post-migration backup...") or all past ("All endpoints have successfully communicated with 2510.", "You have verified all integrations.", etc.). Past-perfect ("have verified", "have satisfied", "have created", "have successfully communicated") reads most naturally for completion criteria.

docs/endpointprotector/install/migrationprocedure/migrationguide.md

  • Clarity — Line 406: "To upgrade a clean appliance, activate at least a Trial license." The phrasing "at least a Trial license" is awkward — the reader may wonder what license tier is being compared against. Suggested fix: "To upgrade a clean appliance, you must have at least a Trial license active. Go to System ConfigurationLicensing and choose Free Trial."
  • Clarity — Line 515: "Understanding the required package set requires knowing why a direct upgrade from older 5.x clients to 2605 isn't possible." Two gerunds chained with "requires" is heavy. Suggested fix: "Before you choose which packages to upload, you need to understand why older 5.x clients can't upgrade directly to 2605."

Summary

11 editorial suggestions across 5 files. The most consequential is the broken numbered-list structure in newoutlook.md (two items labeled 4.) and the version mismatch between the intro paragraph and the support table in index.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
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

15 issues fixed, 14 skipped across 5 files

Category Fixes
Dale: minimizing-difficulty 1
Dale: misplaced-modifiers 1
Dale: passive-voice 13
Skipped (needs manual review) Reason

| docs/endpointprotector/admin/cap_module/capai.md:11 — Dale: passive-voice | 'become increasingly integrated' — rewording would shift meaning of the descriptive opening sentence |
| docs/endpointprotector/admin/cap_module/capai.md:70 — Dale: xy-slop | 'the interaction was genuine and not a simulated or dummy web transaction' — negation is integral to the video description's verification claim; rewriting would lose nuance |
| docs/endpointprotector/admin/cap_module/capai.md:73 — Dale: minimizing-difficulty | 'integrates seamlessly' appears inside a bolded conclusion sentence describing video content — marketing language, but altering bold quoted text risks misrepresenting the video |
| docs/endpointprotector/admin/cap_module/capai.md:75 — Dale: undefined-acronyms | 'PII' appears only in a heading; rule excludes acronyms used only in headings |
| docs/endpointprotector/admin/cap_module/newoutlook.md:57 — Dale: passive-voice | 'users with the add-in assigned' — restructuring would clutter the warning admonition without clear improvement |
| docs/endpointprotector/admin/cap_module/newoutlook.md:132 — Dale: passive-voice | 'assuming the EPP Client isn't present' — participle has ambiguous referent; safer to leave |
| docs/endpointprotector/index.md:19 — Dale: passive-voice | 'sensitive data remains protected' — stative passive; active rewrite would change scope (protected by what) |
| docs/endpointprotector/install/migrationprocedure/faq.md:15 — Dale: passive-voice | 'backups created on version 5.9.4.2' — passive participle is conventional product-version phrasing; alternative wording risks ambiguity |
| docs/endpointprotector/install/migrationprocedure/faq.md:100 — Dale: passive-voice | 'Confirm client communications are enabled on the server' — stative passive describing UI state; active rewrite would shift focus |
| docs/endpointprotector/install/migrationprocedure/faq.md:160 — Dale: misplaced-modifiers | 'after upgrading to 2601' — conventional gerund phrase; rewriting may add awkwardness without clarity gain |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:25 — Dale: xy-slop | 'requires a full image migration — not a simple patch' — em-dash contrast is idiomatic emphasis, not the canonical 'X is not Y, X is Z' definition pattern |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:50 — Dale: passive-voice | 'any patch version built on top of it' — reduced passive participle in parenthetical; rewriting risks reading awkwardly |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:71 — Dale: passive-voice | 'backups created on exactly version 5.9.4.2' — conventional product-version phrasing similar to line 15 |
| docs/endpointprotector/install/migrationprocedure/migrationguide.md:623 — Dale: passive-voice | 'Verify that backups are configured and active' — stative passive describing system state |

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

@jth-nw jth-nw merged commit aed3a58 into dev May 11, 2026
10 checks passed
@jth-nw jth-nw deleted the eppminor20260508 branch May 11, 2026 13:53
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