Skip to content

Update privilegesecure.md: improve cross-references and content#773

Open
pavelshabanov2025 wants to merge 16 commits intodevfrom
update-docs-na-privilegesecure
Open

Update privilegesecure.md: improve cross-references and content#773
pavelshabanov2025 wants to merge 16 commits intodevfrom
update-docs-na-privilegesecure

Conversation

@pavelshabanov2025
Copy link
Copy Markdown
Contributor

@pavelshabanov2025 pavelshabanov2025 commented Apr 16, 2026

  • Replace boilerplate "See the ... topic for additional information" with "For details, see [X]"
  • Add Exchange to supported data sources list
  • Rewrite Step 7 to use the in-product certificate export flow
  • Add missing NOTE blocks and fix Step 8 option wording
  • Add key concepts section (Resource-based, Credential-based, Connection Profile)
  • Add session duration guidance for Connection Profile configuration
  • Fix frontmatter description, trailing whitespace, and article inconsistencies

Doc Task 347128: Enhance the NPS integration documentation

- Replace boilerplate "See the ... topic for additional information" with "For details, see [X]"
- Add Exchange to supported data sources list
- Rewrite Step 7 to use the in-product certificate export flow
- Add missing NOTE blocks and fix Step 8 option wording
- Add key concepts section (Resource-based, Credential-based, Connection Profile)
- Add session duration guidance for Connection Profile configuration
- Fix frontmatter description, trailing whitespace, and article inconsistencies

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
Clarified instructions for exporting the Netwrix Auditor server certificate and updated notes on Connection Profiles.
Comment thread docs/auditor/10.8/admin/settings/privilegesecure.md Outdated
Comment thread docs/auditor/10.8/admin/settings/privilegesecure.md Outdated
Comment thread docs/auditor/10.8/admin/settings/privilegesecure.md
Comment thread docs/auditor/10.8/admin/settings/privilegesecure.md Outdated
Comment thread docs/auditor/10.8/admin/settings/privilegesecure.md Outdated
Comment thread docs/auditor/10.8/admin/settings/privilegesecure.md Outdated
pavelshabanov2025 and others added 2 commits April 20, 2026 13:52
- privilegesecure.md: add Exchange to supported data sources list, update
  cross-references, add key concepts section (Access Policy, Activity),
  and update screenshots
- exchange/overview.md: add "Use Netwrix Privilege Secure as a Data
  Collecting Account" section
- Add new screenshots: npsapplicationuser, npsclientcertificatecopy

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
Keep Access Policy concept definition added locally; use contraction
form ("don't need") from remote for Resource-based description.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
- privilegesecure.md: move Key Concepts to dedicated section before
  procedure, extract Step 6 (Click Next), fix Step 7 wording, move
  cross-reference to NOTE under Step 9, add period to Step 10,
  renumber steps to 11 total
- exchange/overview.md: fix lowercase "ensure" typo introduced by
  Vale autofix agent

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

7 issues fixed, 2 skipped across 2 files

Category Fixes
Dale: passive-voice 4
Dale: wordiness 3
Skipped (needs manual review) Reason
docs/auditor/10.8/admin/monitoringplans/exchange/overview.md:9 — Netwrix.OxfordComma False positive: 'plan,' ends an introductory clause, and 'read and complete' is a two-item series — no Oxford comma required.
docs/auditor/10.8/admin/monitoringplans/exchange/overview.md:27 — Netwrix.OxfordComma False positive: 'computer,' separates a main clause from a participial phrase, and 'collecting and prefiltering' is a two-item series — no Oxford comma required.

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

@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/auditor/10.8/admin/monitoringplans/exchange/overview.md

  • Clarity — Line 54: "Netwrix Auditor will not store the credentials. Instead, Netwrix Privilege Secure will manage and provide them on demand" uses future tense. Per Netwrix standards, use present tense to describe system behavior. Suggested fix: "Netwrix Auditor does not store the credentials. Instead, Netwrix Privilege Secure manages and provides them on demand"

  • Clarity — Line 54: "ensuring password rotation or using temporary accounts for data collection" conflates two distinct behaviors (credential-based password rotation vs. resource-based temporary accounts) in a single phrase, which is confusing. Suggested fix: "either by rotating passwords or by creating temporary accounts for data collection."

  • Completeness — Line 68: The cross-reference for Access Policy information points to an external URL (helpcenter.netwrix.com), but privilegesecure.md in this same documentation site now includes a Key Concepts section that explains Access Policies. An internal link would keep readers within the documentation ecosystem and surface the newly added Key Concepts content. Suggested fix: Link to the Key Concepts section of the Netwrix Privilege Secure settings page instead of the external URL.

  • Clarity — Line 71: "and to which Netwrix Auditor has the access through a Credential-based access policy" is grammatically awkward ("has the access" should be "has access") and the relative clause is hard to parse. Suggested fix: "Provide the username of the account managed by Netwrix Privilege Secure. Netwrix Auditor accesses this account through a Credential-based access policy."

  • Clarity — Lines 79–81: "you need to provide" should be a direct imperative ("Provide") per Netwrix procedure conventions. "Ensure that you specified" uses past tense and should be present tense. Suggested fix: "Provide the Activity and Resource names defined for Netwrix Auditor in the Resource-based policy. Ensure the names match those configured in Netwrix Privilege Secure."

  • Clarity — Lines 83–85: Future tense ("will be performed," "will be granted") should be present tense. "grant the data collecting account the access" should be "grant the data collecting account access." The hyphen ("-") used before the inline example should be an em dash ("—"). Suggested fix: "The Resource name is the target system where the activity is performed. For example, if you grant the data collecting account access to a local Administrators group — the resource is the server where the permission is granted."


docs/auditor/10.8/admin/settings/privilegesecure.md

  • Clarity — Line 84: Sub-step 2 of Step 7 chains multiple sequential actions into one instruction (navigate to the Details tab, click Copy to File, follow the wizard, select the export format). Each distinct action should be its own step or the wizard instruction should be clearly separated. Suggested fix: "In the window that appears, go to the Details tab and click Copy to File. Follow the Certificate Export Wizard and select DER encoded binary X.509 (.CER) as the export format."

  • Clarity — Line 97: "the Application name and Certificate Serial Number that you received" is vague about where these values come from. A reader who just generated a certificate in Step 5 may not make the connection. Suggested fix: "the Application name and Certificate Serial Number displayed in Step 5."

  • Completeness — Line 109: "After validation, click Finish" does not tell the reader what triggers validation or whether it is automatic. Suggested fix: "After Netwrix Auditor validates the connection, click Finish."

  • Completeness — Lines 113–115: The closing paragraph no longer includes a cross-reference to Netwrix Privilege Secure documentation for creating the required Access Policy and Connection Profile, which are prerequisites for using the integration. The previous version linked to those instructions. Suggested fix: Add a link — for example: "For instructions on creating an Access Policy and Connection Profile, see the Netwrix Privilege Secure documentation."


Summary

10 editorial suggestions across 2 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.

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