Skip to content

Test: dale — Apply violation fixes#754

Merged
hilram7 merged 4 commits intodevfrom
test/dale-update-violation-fixes
Apr 14, 2026
Merged

Test: dale — Apply violation fixes#754
hilram7 merged 4 commits intodevfrom
test/dale-update-violation-fixes

Conversation

@hilram7
Copy link
Copy Markdown
Collaborator

@hilram7 hilram7 commented Apr 14, 2026

Summary

  • Applies dale linter style corrections across ~25 KB articles and docs files.
  • Moves the WinRM troubleshooting article from the 1Secure KB folder to the correct Privilege Secure folder.

Changes

KB Only

  • Write contractions out in full (do not, have not, are not, does not)
  • Convert headings to title case per KB style guide
  • Fix truncated sidebar_label in Privilege Secure AD FS article
  • Move WinRM troubleshooting article from 1Secure to Privilege Secure KB folder
  • Rewrite resolution steps from case-note style to instructional style in permission scanning article

Docs and KB

  • Rewrite passive voice to active voice
  • Remove filler words ("Remember, always verify…" → "Verify…")
  • Replace first-person constructions ("we recommend", "we discovered") with an active subject (product name or "you")
  • Spell out acronyms on first use (USN → Update Sequence Number, CAP → Content Aware Protection, RADIUS → Remote Authentication Dial-In User Service, EPE → Enterprise
    Password Enforcer)
  • Replace:
    • "Once [action] has been completed" with "After you [action]"
    • "It provides the ability to" and similar impersonal constructions with direct descriptions
    • Bare URLs with formatted markdown links
    • "inbuilt" with "built-in"

Testing

hilram7 added 4 commits April 10, 2026 23:44
Resolves passive voice, wordiness, positional references, minimizing-difficulty,
undefined acronyms, and idiom violations flagged by the dale linter. Defines
product-specific acronyms (NPS, EPE, SAM, CEE, AMQP, FSAA, SPAA, SPAC, SPSEEK,
USN, RADIUS, CAP, NPR, DSM, SMB, CIFS, DoD, SVM, CORS, UNC) on first use across
KB and product docs.
Article content is NPS-specific (Action Service, PSRemoting/WinRM) and was
incorrectly tagged with 'products: onesecure' during migration from Salesforce,
causing it to land in docs/kb/1secure/ instead of docs/kb/privilegesecure/.
Updates products frontmatter from onesecure to privilegesecure, moves file to
privilegesecure/troubleshooting-and-errors/, and removes orphaned duplicate
images from docs/kb/1secure/0-images/ (all 22 already present in
privilegesecure/0-images/).
- Write contractions out in full (do not, have not, are not)
- Convert headings to title case
- Rewrite passive voice constructions to active voice
- Fix truncated sidebar label in Privilege Secure AD FS article
- Fix bare URL and first-person language in permission scanning article
- Update support link in Privilege Secure byovconnectorconfig
@hilram7 hilram7 requested review from a team as code owners April 14, 2026 16:40
@hilram7 hilram7 marked this pull request as draft April 14, 2026 16:40
@hilram7 hilram7 changed the title Test/dale update violation fixes Test: dale — Apply violation fixes Apr 14, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/accessanalyzer/12.0/requirements/filesystem/filesystems/netappcmode/activity/configurefpolicy.md

  • Clarity — Line 173: The modified line ends with "It is necessary to" — a weak, impersonal construction carried over from the old text — and the sentence continues on the unchanged line below ("create several FPolicy components and then enable the FPolicy."). Suggested fix: Rewrite as "You must create several FPolicy components and then enable FPolicy."

docs/auditor/10.8/requirements/supporteddatasources/supporteddatasources.md

No issues found.

docs/changetracker/8.1/admin/devicediscoveryregistration/devicediscoveryregistration.md

  • Clarity — Line 252: "devices requiring manual intervention can always be found in the 'New Devices' group" uses passive voice. Suggested fix: "you can always find devices requiring manual intervention in the 'New Devices' group, preventing them from being lost in the system."

docs/endpointprotector/gettingstarted.md

  • Clarity — Line 14: "Ensure compliance and protect sensitive information with Netwrix Endpoint Protector." is marketing language on a modified line. Netwrix writing standards call for a neutral, informative tone with no marketing language. Suggested fix: Replace with a factual closing statement, such as "Endpoint Protector prevents unauthorized data transfers and protects sensitive information across your endpoints."

docs/passwordreset/3.3/administration/securing_password_reset.md

No issues found.

docs/privilegesecure/4.2/admin/configuration/integrationconnector/integrationbyov/byovconnectorconfig.md

No issues found.

docs/threatmanager/3.0/threats/overview.md

No issues found.

docs/threatmanager/3.1/administration/configuration/integrations/activedirectorysync.md

No issues found.

docs/threatmanager/3.1/administration/configuration/systemsettings/useraccess.md

No issues found.

docs/threatprevention/7.5/requirements/eperestsite.md

No issues found.

Summary

3 editorial suggestions across 3 files. 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.

@hilram7 hilram7 marked this pull request as ready for review April 14, 2026 16:53
@hilram7 hilram7 merged commit 7ecf7b3 into dev Apr 14, 2026
10 checks passed
@hilram7 hilram7 deleted the test/dale-update-violation-fixes branch April 14, 2026 16:55
@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

120 issues fixed, 4 skipped across 10 files

Category Fixes
Contractions 23
Plurals 4
Removed filler 1
Substitutions 24
AllowsYouTo (rewrite) 2
BoilerplateCrossRef (rewrite) 11
CanBeUsedTo (rewrite) 3
FollowTheStepsTo (rewrite) 12
FormalHedging (rewrite) 3
Idioms (rewrite) 1
ImpersonalFiller (rewrite) 1
NoteThat (rewrite) 1
OnceUsage (rewrite) 4
PlainTextAdmonition (rewrite) 10
Dale: idioms 1
Dale: passive-voice 15
Dale: positional-references 3
Dale: wordiness 1
Skipped (needs manual review) Reason

| docs/changetracker/8.1/admin/devicediscoveryregistration/devicediscoveryregistration.md:154 — Dale: passive-voice | ambiguous pronoun 'it' in 'When a device is first discovered or re-registered, it follows this sequence' — rewrite would require significant restructuring |
| docs/changetracker/8.1/admin/devicediscoveryregistration/devicediscoveryregistration.md:219 — Dale: passive-voice | parenthetical 'placed there during initial discovery' — skipped to avoid awkward restructuring of list item |
| docs/accessanalyzer/12.0/requirements/filesystem/filesystems/netappcmode/activity/configurefpolicy.md:587 — Dale: passive-voice | 'two FPolicy Event were created' refers to prior steps completed by the user — context is ambiguous |
| docs/accessanalyzer/12.0/requirements/filesystem/filesystems/netappcmode/activity/configurefpolicy.md:20 — Dale: idioms | 'fine-tune' is widely used in technical documentation and understood cross-culturally — skipped |

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.

2 participants