Skip to content

Fix/1secure vale dale#902

Merged
jth-nw merged 4 commits into
devfrom
fix/1secure-vale-dale
May 13, 2026
Merged

Fix/1secure vale dale#902
jth-nw merged 4 commits into
devfrom
fix/1secure-vale-dale

Conversation

@jth-nw
Copy link
Copy Markdown
Collaborator

@jth-nw jth-nw commented May 13, 2026

No description provided.

jth-nw and others added 2 commits May 12, 2026 10:58
Ran Vale and Dale across all 127 user-facing markdown files in
docs/1secure/ and fixed all 521 Vale warnings/suggestions and all
Dale violations found.

Vale fixes: contractions, dropdown/checkbox spelling, Oxford comma,
FollowTheStepsTo restructuring, AllowsYouTo rewrites, WeakLinkText,
MakeSure, TypeVsEnter, Plurals, LoginVerb, BoilerplateCrossRef.

Dale fixes: future tense → present tense throughout, passive voice →
active voice, positional references (below/above → "the following"),
hedging language → direct imperatives, conditional-without-imperative
→ direct "To X, do Y" form, wordiness, minimizing-difficulty (easily/
simply removed), idioms, undefined acronyms (MSP, SSO defined on first
use).

Also fixed pre-existing broken links (Windows backslashes) in three
files that caused an infinite loop in the pre-commit hook.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@jth-nw jth-nw requested a review from a team as a code owner May 13, 2026 14:33
@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

This PR is a large editorial pass across the entire docs/1secure/ tree (117 files). Most changes are mechanical and Vale/Dale-aligned: "drop-down" → "dropdown", "Follow the steps to X." → "To X:", future tense → active present, "make sure" → "ensure", "cannot" → "can't", removal of "currently"/"below" qualifiers, and fixes for broken backslash links. Those are good. Below are issues that genuinely affect readability or break rendering, plus a handful of consistency slips.

Editorial Review

docs/1secure/integration/connectwise.md

  • Clarity — Line 9: "Integrated with Netwrix 1Secure, With the ConnectWise integration, you can deliver an alert as a ticket…" reads as two grafted phrases — the leftover "Integrated with Netwrix 1Secure," from the original sentence plus the new "With the ConnectWise integration, you can…". Suggested fix: drop the leftover prefix — "With the ConnectWise integration, Netwrix 1Secure can deliver an alert as a ticket…".
  • Consistency — Lines 23, 67, 96: procedure intros use plain "To add a ConnectWise company in Netwrix 1Secure:" / "To manage delivery settings for ConnectWise:". Every other file in this PR uses the bold form (**To X:**). Suggested fix: bold these intros to match the established pattern.

docs/1secure/integration/servicenow.md

  • Clarity — Lines 9–10: same duplicated-phrase issue as ConnectWise: "Integrated with Netwrix 1Secure, With the ServiceNow integration, you can deliver an alert…". Suggested fix: "With the ServiceNow integration, Netwrix 1Secure can deliver an alert as a ticket or a work note…".
  • Consistency — Lines 25, 63: "To add a ServiceNow integration system:" and "To manage delivery settings for ServiceNow:" are not bolded. Suggested fix: bold to match **To X:** convention.

docs/1secure/integration/sharepointonline.md

  • Consistency — Line 18: "To add the SharePoint Online integration in Netwrix 1Secure:" is not bolded. Suggested fix: **To add the SharePoint Online integration in Netwrix 1Secure:**.
  • Clarity — Lines 49–52: the :::note warning that you must add Sites.ReadWrite.All is positioned after Step 4 – Click Finish, but says "before completing this step." A reader naturally maps "this step" to Step 4. The permission is actually a prerequisite for the whole procedure. Suggested fix: move the note above Step 1, or rephrase to "Add this permission before you start this procedure."

docs/1secure/install/installagent.md

  • Clarity — Line 16: "To collect the data from the Computer and Active Directory, install, and configure the Netwrix Cloud Agent." The added comma after "install" turns a two-verb compound ("install and configure") into what reads like a three-item list. Suggested fix: drop the comma — "install and configure the Netwrix Cloud Agent."
  • Consistency — Lines 18, 53: "To configure an agent:" / "To install the agent:" are not bolded. Suggested fix: bold to match **To X:** convention used elsewhere in the PR.

docs/1secure/admin/organizations/addsites.md

  • Clarity — Line 56: "Step 2 – Select your site from the dropdown list or click the Add icon, if your want to add a new site." The line was modified in this PR (drop-down → dropdown) but the pre-existing typo "your want" was preserved. Suggested fix: "if you want to add a new site."

docs/1secure/admin/organizations/sourcesandconnectors/sharepointonline.md

  • Structure — Lines 79–93: the new :::note block ("This increases the processing time…") is inserted at column 0, breaking the surrounding two-level bullet list. The "Run OCR…" bullet ends at line 86, the note sits at outer scope at lines 88–90, then "In the Sensitive Data Types to Classify area" resumes at 4-space indent. Docusaurus will render the trailing bullets outside the parent list. Suggested fix: indent the :::note block to match the bullet's 6-space indent so it stays inside the "SharePoint Online Data Classification" sub-list, or attach the sentence directly to the "Run OCR" bullet as continuation prose.

docs/1secure/admin/searchandreports/filteroperators.md

  • Consistency — Lines 24, 26: the operator names "Does not contain" and "Does not exist" are wrapped in backticks (`Does not contain`, `Does not exist`) inside the table, which renders them as inline code. None of the other operator names in the same table (Contains, Equals, Starts with, etc.) are formatted that way. Suggested fix: remove the backticks so all operator labels render consistently in plain text.

docs/1secure/admin/searchandreports/compliance.md

  • Clarity — Line ~102 (the "AD and Microsoft Entra ID User Attributes filters" row): the attribute names "Account Cannot be Delegated" and "Cannot Change Password" wrap only the word "Cannot" in backticks. The result is half-code/half-prose UI labels in a long bulleted list of plain attribute names. Suggested fix: remove the backticks. If this was inserted to dodge a Vale rule, scope the suppression with <!-- vale Netwrix.Cannot = NO --> around the row instead of altering rendering.

docs/1secure/configuration/networktrafficcompression.md

  • Clarity — Lines 9–10: "Install special Netwrix utilities in the audited environment for this purpose. These utilities run on the target computers, collect, and pre-filter data, and send it to Netwrix Cloud Agent…". The comma after "collect" creates a stray Oxford comma in what should read as a two-action sequence ("collect and pre-filter data"). Suggested fix: "These utilities run on the target computers, collect and pre-filter data, and send it to Netwrix Cloud Agent…".

docs/1secure/admin/organizations/addingusers/addingusers.md

  • Structure — Lines 210–217 (the "Delete a Managed Organization User" section): the :::note admonition about who can delete users now appears immediately under the H2 heading and before the procedure intro **To delete a user from a managed organization:**. This works, but it's the inverse of how every other section in this file orders the same elements (intro first, note after). Suggested fix: either move the note below the procedure intro to match the rest of the document, or apply the new ordering consistently across the other "Delete" sections.

Files checked with no editorial issues found (additions are routine drop-down/voice/contraction cleanups):

docs/1secure/admin/alerts/alerts.md, docs/1secure/admin/alerts/overview.md, docs/1secure/admin/dashboard/alertstimeline.md, docs/1secure/admin/dashboard/organizationstatistics.md, docs/1secure/admin/dashboard/overview.md, docs/1secure/admin/datacollection/activedirectoryauditing/activedirectoryauditing.md, docs/1secure/admin/datacollection/activedirectoryauditing/auditlogging.md, docs/1secure/admin/datacollection/activedirectoryauditing/auditlogsrole.md, docs/1secure/admin/datacollection/activedirectoryauditing/logonasbatch.md, docs/1secure/admin/datacollection/activedirectoryauditing/manageauditingsecuritylog.md, docs/1secure/admin/datacollection/activedirectoryauditing/permissionsadcontainer.md, docs/1secure/admin/datacollection/activedirectoryauditing/permissionsregistrykeys.md, docs/1secure/admin/datacollection/computer/backupfilesdirectories.md, docs/1secure/admin/datacollection/computer/overview.md, docs/1secure/admin/datacollection/entraid.md, docs/1secure/admin/datacollection/exchangeonline.md, docs/1secure/admin/datacollection/gmsa.md, docs/1secure/admin/datacollection/logonactivity/**, docs/1secure/admin/datacollection/overview.md, docs/1secure/admin/datacollection/sharepointonline.md, docs/1secure/admin/howitworks.md, docs/1secure/admin/login/login.md, docs/1secure/admin/login/sso.md, docs/1secure/admin/notifications.md, docs/1secure/admin/organizations/addorganizations.md, docs/1secure/admin/organizations/billableaccounts.md, docs/1secure/admin/organizations/managemyorganization.md, docs/1secure/admin/organizations/managingcredentials.md, docs/1secure/admin/organizations/organizationgroups.md, docs/1secure/admin/organizations/overview.md, docs/1secure/admin/organizations/sourcesandconnectors/activedirectory.md, docs/1secure/admin/organizations/sourcesandconnectors/computer.md, docs/1secure/admin/organizations/sourcesandconnectors/entraid.md, docs/1secure/admin/organizations/sourcesandconnectors/exchangeonline.md, docs/1secure/admin/organizations/sourcesandconnectors/overview.md, docs/1secure/admin/organizations/sourcesandconnectors/sqlserver.md, docs/1secure/admin/organizations/viewtabsanddashboard.md, docs/1secure/admin/overview.md, docs/1secure/admin/riskprofiles/metrics_list.md, docs/1secure/admin/riskprofiles/riskassessmentdashboard.md, docs/1secure/admin/riskprofiles/riskmetrics.md, docs/1secure/admin/riskprofiles/riskprofiles.md, docs/1secure/admin/searchandreports/activity.md, docs/1secure/admin/searchandreports/applyfilters.md, docs/1secure/admin/searchandreports/auditlogs.md, docs/1secure/admin/searchandreports/billableusers.md, docs/1secure/admin/searchandreports/customreports.md, docs/1secure/admin/searchandreports/exportreport.md, docs/1secure/admin/searchandreports/overview.md, docs/1secure/admin/searchandreports/stateintime.md, docs/1secure/admin/searchandreports/subscriptions.md, docs/1secure/admin/searchandreports/system.md, docs/1secure/admin/statuses.md, docs/1secure/admin/updatenetwrixcloudagent.md, docs/1secure/configuration/admanual/**, docs/1secure/configuration/computer/**, docs/1secure/configuration/configureitinfrastructure.md, docs/1secure/configuration/exchangeonlinenonowner.md, docs/1secure/configuration/gpmanual/**, docs/1secure/configuration/logonactivity/**, docs/1secure/configuration/overview.md, docs/1secure/configuration/registerconfig/**, docs/1secure/configuration/sqlserver/**, docs/1secure/configuration/windowsserver/**, docs/1secure/install/overview.md, docs/1secure/integration/overview.md, docs/1secure/requirements/CloudAgentRequirements.md, docs/1secure/requirements/prerequisitesfordatasources.md, docs/1secure/security/**, docs/1secure/setup-and-configuration/index.md.

docs/1secure/CLAUDE.md is agent-facing guidance and not subject to editorial review.

Summary

11 editorial issues across 9 files, in a PR spanning 117 files. The recurring patterns to fix are: (1) the leftover "Integrated with Netwrix 1Secure," prefix in the two integration files, (2) inconsistent bolding of **To X:** procedure intros in the integration and install files, (3) backtick-wrapped UI labels in two filter tables, and (4) one admonition indentation that breaks list rendering. 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

13 issues fixed, 25 skipped across 116 files

Category Fixes
Dale: idioms 1
Dale: passive-voice 3
Dale: positional-references 1
Dale: undefined-acronyms 1
Dale: wordiness 7
Skipped (needs manual review) Reason

| docs/1secure/admin/datacollection/computer/backupfilesdirectories.md:37 — Dale: positional-references | 'Windows 2012 R2 and below' refers to version numbers, not document position |
| docs/1secure/admin/datacollection/activedirectoryauditing/permissionsregistrykeys.md:37 — Dale: positional-references | 'Windows 2012 R2 and below' refers to version numbers, not document position |
| docs/1secure/admin/riskprofiles/riskmetrics.md:92 — Dale: positional-references | '10 and above' is a numeric threshold, not a document position |
| docs/1secure/admin/searchandreports/applyfilters.md:72 — Dale: positional-references | 'below the Search bar' describes physical UI layout, not document position |
| docs/1secure/admin/organizations/sourcesandconnectors/sqlserver.md:77 — Dale: positional-references | 'field below' refers to UI placement on screen, not document position |
| docs/1secure/admin/organizations/sourcesandconnectors/sqlserver.md:88 — Dale: positional-references | 'field below' refers to UI placement on screen, not document position |
| docs/1secure/configuration/windowsserver/remoteregistry.md:24 — Dale: positional-references | 'Windows Server 2012 and above' refers to version numbers, not document position |
| docs/1secure/configuration/windowsserver/advancedpolicy.md:85 — Dale: positional-references | 'Windows Server 2016 and above' refers to version numbers, not document position |
| docs/1secure/admin/datacollection/activedirectoryauditing/logonasbatch.md:39 — Dale: positional-references | 'Windows 2012 R2 and below' refers to version numbers, not document position |
| docs/1secure/configuration/windowsserver/eventlog.md:21 — Dale: positional-references | 'Windows Server 2012 R2 and above' refers to version numbers, not document position |
| docs/1secure/configuration/windowsserver/eventlog.md:62 — Dale: positional-references | 'Windows Server 2012 R2 and above' refers to version numbers, not document position |
| docs/1secure/configuration/computer/remoteregistryservice.md:24 — Dale: positional-references | 'Windows Server 2012 and above' refers to version numbers, not document position |
| docs/1secure/configuration/computer/advancedpolicy.md:33 — Dale: positional-references | 'Windows Server 2016 and above' refers to version numbers, not document position |
| docs/1secure/configuration/gpmanual/permissions.md:75 — Dale: positional-references | 'Windows 2012 R2 and below' refers to version numbers, not document position |
| docs/1secure/configuration/admanual/objectlevel.md:68 — Dale: positional-references | 'Server 2008 and above' refers to version numbers, not document position |
| docs/1secure/admin/dashboard/alertstimeline.md:61 — Dale: negative-assumptions | 'unable to communicate' describes system state, not user capability |
| docs/1secure/configuration/computer/overview.md:60 — Dale: negative-assumptions | 'product is unable to parse' describes system state, not user capability |
| docs/1secure/configuration/registerconfig/1secure-classifier-setup-guide.md:135 — Dale: negative-assumptions | 'classifier has been unable to process' describes system state, not user capability |
| docs/1secure/admin/overview.md:12 — Dale: minimizing-difficulty | 'With Netwrix 1Secure, ... can run reports' states a capability without minimizing language like 'easily' or 'simply' |
| docs/1secure/admin/updatenetwrixcloudagent.md:9 — Dale: minimizing-difficulty | 'With Netwrix 1Secure, you can update the agent' states a capability without minimizing language like 'easily' or 'simply' |
| docs/1secure/admin/dashboard/overview.md:10 — Dale: minimizing-difficulty | 'quickly identify and prioritize what requires immediate attention' describes the urgency goal of users, not assumed task ease |
| docs/1secure/admin/alerts/overview.md:11 — Dale: passive-voice | 'when alerts ... are triggered' — standard UI/system-event phrasing; rewriting requires inventing an artificial subject |
| docs/1secure/admin/alerts/alerts.md:27 — Dale: passive-voice | 'The alerts for the profile are displayed in a list' — standard UI documentation phrasing; common pattern throughout the file set |
| docs/1secure/configuration/configureitinfrastructure.md:63 — Dale: passive-voice | 'The Advanced audit policy settings can be configured' — no clear actor; rewriting would change meaning |
| docs/1secure/admin/datacollection/gmsa.md:64 — Dale: passive-voice | 'Computer accounts that are allowed to use that gMSA' — ambiguous about who grants permission; rewrite risks altering meaning |

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

@jth-nw jth-nw merged commit eebc6fb into dev May 13, 2026
10 checks passed
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.

1 participant