Skip to content

Feature/ppe april2 jm2#830

Open
jeremymoskowitz-netwrix wants to merge 10 commits intodevfrom
feature/ppe-april2-jm2
Open

Feature/ppe april2 jm2#830
jeremymoskowitz-netwrix wants to merge 10 commits intodevfrom
feature/ppe-april2-jm2

Conversation

@jeremymoskowitz-netwrix
Copy link
Copy Markdown
Collaborator

Added one PP article about SSO (ships May 4th, but approve asap.) And some updates to PPE supportability Policies.

jeremymoskowitz-netwrix and others added 2 commits April 27, 2026 15:55
- Add new Single Sign On category and article for PolicyPak Cloud KB
- Add 6 SSO screenshots to static/images
- Update bug reporting, component versioning, and OS support sections
  in ppe-supportability.md across versions 10.2, 11.0, and 11.1

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
Apply the three content updates (bug reporting policy, component
versioning paragraph, OS support section) to the canonical file at
docs/kb/passwordpolicyenforcer/ppe-supportability.md. Remove the
force-tracked versioned copies — these are gitignored by design and
will be regenerated by the KB copy script at build time.

Generated with AI

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

Auto-Fix Summary

9 issues fixed, 3 skipped across 1 files

Category Fixes
Contractions 2
Dale: idioms 1
Dale: passive-voice 5
Dale: positional-references 1
Skipped (needs manual review) Reason
docs/policypak/deliverymethods/cloud/knowledgebase/singlesignon/sso.md:46 — Netwrix.FirstPerson 'my' appears inside the UI button label 'Activate my Netwrix account' (bold = UI element). Changing it would misrepresent the actual button text in the interface.
docs/policypak/deliverymethods/cloud/knowledgebase/singlesignon/sso.md:56 — Dale: passive-voice "If the user isn't already provisioned" — unclear who does the provisioning; fix would require domain knowledge to avoid changing meaning
docs/policypak/deliverymethods/cloud/knowledgebase/singlesignon/sso.md:108 — Dale: passive-voice "No action required from you" in a summary list — telegraphic summary style; acceptable in list context

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

@jeremymoskowitz-netwrix
Copy link
Copy Markdown
Collaborator Author

@claude fix all issues then publish.

- Promote bold-text section headers to proper ## headings
- Remove duplicate 3-business-day SLA note from Step 1 body
- Fix third-person "user" → second-person "you" in Step 4
- Fix mixed second/third person in Step 7 intro sentence
- Clarify activation link expiry: "48 hours after it is sent"
- Fix "continue" → "sign in to PolicyPak Cloud" in Step 7
- Add 1Secure context sentence at top of Step 2
- Add OIDC provider note in Step 5
- Rewrite "Use the following guides" → "Before continuing, register..." in Step 5

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

Auto-Fix Summary

8 issues fixed, 1 skipped across 1 files

Category Fixes
QuestionHeadings (rewrite) 1
Dale: misplaced-modifiers 1
Dale: passive-voice 4
Dale: undefined-acronyms 1
Dale: wordiness 1
Skipped (needs manual review) Reason
docs/policypak/deliverymethods/cloud/knowledgebase/singlesignon/sso.md:44 — Netwrix.FirstPerson 'my' appears in a UI button label (Activate my Netwrix account) — changing it would misrepresent the actual button text shown in the interface

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

Copy link
Copy Markdown
Collaborator

@hilram7 hilram7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran Vale, Dale, and Derek on ppe-supportability.md. The sso.md file was reviewed separately — see notes below. I'll push a follow-up commit with all fixes.


ppe-supportability.md

Vale:

  • Lines 123, 140 — first person plural (we). Rewrite without "we", "our", "us", or "ours."

Dale:

  • Line 104 — passive voice: "Running mismatched component versions is not a supported configuration." Rewrite in active voice.
  • Line 140 — passive voice: "PPE's components...are developed and tested as a single package." Rewrite in active voice.
  • Line 140 — wordiness: "You will have the best experience using all the components from a single version." Suggest trimming.

Derek:

  • Line 26 — title contains a product name. Product names belong in the products frontmatter field. Suggest "Understanding PPE Supportability" or "Password Policy Enforcer
    Support Levels."

I'll push a follow-up commit with all fixes.


sso.md

This file lives under docs/policypak/ and follows that product's own doc structure — standard KB rules don't fully apply. The one Vale warning (line 44, first person my) is a
false positive — it flags the button label text "Activate my Netwrix account," not author-written first person. No fixes needed.


Note for future PRs: PPE and PolicyPak are separate products — keeping changes scoped to one product per PR makes reviews easier to track.

I'll push a follow-up commit with all fixes.

Ran Vale, Dale, and Derek. Applied all fixes.

- Removed product name from title: "Understanding PPE Supportability"
- Rewrote passive voice on lines 104 and 140
- Replaced first person plural (we/our) on lines 123 and 140
- Trimmed wordiness on line 140

Local dev and build tests passed with no errors.
hilram7
hilram7 previously approved these changes May 5, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

Documentation PR Review

Editorial Review

docs/policypak/deliverymethods/cloud/knowledgebase/singlesignon/sso.md

  • Structure — Line 68 vs. lines 74–77: The instruction to "supply the Client ID and Client Secret from your identity provider" appears before the "Before continuing, register your application and obtain a Client ID and Client Secret" paragraph that follows. A reader following the guide step-by-step will reach the credential fields in the UI before seeing the instruction to register their application and generate those credentials — the prerequisite comes after the action it enables. Suggested fix: Move the "Before continuing, register your application…" paragraph and its two links to appear before the sentence "Select your SSO method…enter your domain name, and supply the Client ID and Client Secret."

  • Clarity — Line 54: "If your account isn't already set up, clicking the activation link prompts you to create a password for your Netwrix account." The conditional is unexplained — a reader receiving a fresh 1Secure invitation won't know when this condition would be false or whether this step applies to them. Suggested fix: Either remove the conditional entirely ("Clicking the activation link prompts you to create a password for your Netwrix account.") or add a brief explanation of the alternate case, for example: "If you already have a Netwrix account from another product, you may be signed in automatically and can skip this step."

  • Clarity — Line 98: "maintaining access to data you have already authorized" is vague. The reader is signing in for the first time and has not yet authorized anything, so "data you have already authorized" is unclear. Suggested fix: Replace with a more concrete description of the consent scope, for example: "The requested permissions cover only viewing your basic profile and allowing 1Secure to authenticate on your behalf. This is a standard consent screen for OIDC-based applications."

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

github-actions Bot commented May 5, 2026

Auto-Fix Summary

2 issues fixed, 1 skipped across 1 files

Category Fixes
Dale: passive-voice 2
Skipped (needs manual review) Reason
docs/policypak/deliverymethods/cloud/knowledgebase/singlesignon/sso.md:44 — Netwrix.FirstPerson 'my' is part of a literal UI button label ('Activate my Netwrix account') that must match the on-screen text exactly; rewriting it would give the reader incorrect instructions.

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.

4 participants