Skip to content

NIM: Add consolidated prerequisites page#788

Merged
KateFlemo merged 2 commits intodevfrom
nim/432864_add_prerequisites
Apr 20, 2026
Merged

NIM: Add consolidated prerequisites page#788
KateFlemo merged 2 commits intodevfrom
nim/432864_add_prerequisites

Conversation

@paigeyoung-netwrix
Copy link
Copy Markdown
Contributor

No description provided.

@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/identitymanager/current/installation-guide/requirements/index.md

  • Clarity — Line 41: "as required by each connector" introduces the term "connector" without definition or a pointer to where connector-specific permission requirements are documented. A reader new to Identity Manager won't know what a connector is or where to find the permissions list for a given connector. Suggested fix: add a brief parenthetical and a cross-reference, e.g., "as required by each connector (see Connectors)" — or whatever the appropriate link target is.

  • Clarity — Line 95: "Domain account recommended over IIS application pool identity when the server connects to a remote SQL Server instance" — the consequence of not following this recommendation is missing. Readers who don't already know IIS won't understand why this matters. Suggested fix: add a brief reason, e.g., "A domain account is recommended over IIS application pool identity when the server connects to a remote SQL Server instance, because application pool identity cannot authenticate to a remote SQL instance."

  • Clarity — Line 101: "identity server authentication" — "identity server" is undefined. It's unclear whether this refers to a product component, an OpenID Connect server, or something else. Suggested fix: spell out what "identity server" refers to on first use, or replace with a more descriptive phrase, e.g., "OpenID Connect identity server" or "the Identity Manager identity server component."

  • Clarity — Line 105: "SQL feed open from the server host to the SQL Server instance" — "SQL feed" is not standard networking terminology. Suggested fix: "TCP connection open from the server host to the SQL Server instance (port 1433 by default)" or simply "SQL Server port accessible from the server host."

  • Completeness — Lines 111–113: The "Component Details" section links to sub-pages with the label "Full requirements for each component," but after reading a consolidated prerequisites page, readers don't know whether they must also read those sub-pages or whether the sub-pages are superseded by this new content. Suggested fix: clarify the relationship, e.g., "The following pages provide detailed hardware and software specifications for each component. Review them after completing this page." Or, if the sub-pages are now redundant, consider removing or updating the label accordingly.

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.

@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

6 issues fixed, 0 skipped across 1 files

Category Fixes
Dale: passive-voice 5
Dale: positional-references 1

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

@KateFlemo KateFlemo merged commit 163316b into dev Apr 20, 2026
9 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.

3 participants