Skip to content

docs: fix #974 — container name format#976

Open
jth-nw wants to merge 2 commits into
devfrom
fix/issue-974-container-name-format
Open

docs: fix #974 — container name format#976
jth-nw wants to merge 2 commits into
devfrom
fix/issue-974-container-name-format

Conversation

@jth-nw
Copy link
Copy Markdown
Collaborator

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

Closes #974

What changed

fix/issue-974-container-name-format

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

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

  • Clarity — Line 65: "OU" is introduced without being spelled out on first use. Netwrix style requires acronyms to be expanded the first time they appear, and this document does not define "OU" earlier. A reader unfamiliar with Active Directory terminology will not know what "OU" stands for. Suggested fix: spell out the acronym on first use — for example, "Use the format <organizational-unit> (OU) or <organizational-unit>/<sub-organizational-unit>."
  • Clarity — Line 65: The example values OU and OU/Sub OU are written as if they were literal strings, which is ambiguous — a reader may believe they should type "OU" verbatim into the Container Name field. Netwrix style uses angle brackets for placeholders, not bare uppercase tokens. Suggested fix: rewrite as <OU-name> or <OU-name>/<sub-OU-name> so the placeholder convention is clear.
  • Completeness — Line 65: The new guidance introduces a format but does not show a concrete example, and docs/CLAUDE.md requires that every concept introduced include an example. Without one, readers must guess what a real container path looks like (single label? distinguished name? slash-delimited?). Suggested fix: add a realistic example after the format, such as "For example, Workstations or Workstations/Sales."

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.

@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

10 issues fixed, 2 skipped across 1 files

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

| docs/1secure/admin/organizations/sourcesandconnectors/computer.md:57 — Dale: minimizing-difficulty | 'makes it easier to manage related sources together' describes a functional benefit of grouping, not a claim that the product makes the user's task easy — borderline and rewording risks changing meaning |
| docs/1secure/admin/organizations/sourcesandconnectors/computer.md:12 — Dale: passive-voice | null |

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.

Feedback: https://docs.netwrix.com/docs/1secure/admin/organizations/sourcesandconnectors/computer

1 participant