PingCastle 4.0 documentation - #1270
Conversation
Adds Enterprise/Pro/Standard docs for PingCastle 4.0, registers the version in products.js as the new default, and removes the unsupported Azure hosting section from the Enterprise install guide now that deployment is Windows-only via the installer. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…r labels CloudAPI microservice and PingCastleSchedulerService replace the old Windows Task Scheduler model; docs and diagrams updated to match. Manual/Linux install and appsettings.json sections removed since Enterprise 4.0 is Windows Server + IIS + SQL Server only. Logging docs rewritten for the new web portal-based configuration. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ork ports Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…NET version refs Expand quick install Step 2 in both tabs with the full wizard walkthrough (prerequisite check, license, install type, app pool identity, auth methods, HTTPS, email) and post-install gotchas; correct ASP.NET 8.0 references to 10.0. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Break the monolithic install page into architecture, requirements, auth setup, email setup, license, post-install, settings, and troubleshooting pages; update sidebar and cross-links accordingly. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Note deleted objects lack links, and list the two audit-log settings under Data Retention instead of just linking out. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Break out action plans, application, data retention, Entra scanner, and scanning/scheduling settings into dedicated pages; update related docs and sidebar links. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Link text still said "Settings: X" and "Enterprise Scheduling" from before the settings pages were split and renamed; update references to match the current page titles, and fill in the Entra tenant connection steps. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
… clarify 3.5-only migration Config migration content belongs with settings docs, not the upgrade guide; also flags the exe.config migration as a one-time 3.5 event.
…/Graph conflict Setup-EntraScannerApp.ps1 had several runtime bugs found while testing against a live tenant: wrong Add-RoleGroupMember param for EXO's cmdlet, missing Get-MgDirectoryRole module import, non-idempotent app role grants on reuse, EXO replication lag on the new service principal, and an Azure.Core version clash between Az.Resources and Microsoft.Graph in the same process. Also exports the generated self-signed cert as a .pfx. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…duler, and settings pages Captures 18 cropped screenshots (content panels only, no nav/sidebar chrome) for new PingCastle 4.0 pages and replaces their TODO markers.
|
| Category | Fixes |
|---|---|
| Dale: positional-references | 2 |
| Skipped (needs manual review) | Reason |
|---|---|
docs/pingcastle/4.0/enterpriseemailsetup.md:45 — Netwrix.TypeVsEnter |
'type' is used as a noun ('the credential type the app registration uses'), not the verb instructing a user to supply text. False positive. |
docs/pingcastle/4.0/enterpriseentrascan.md:118 — Netwrix.FirstPerson |
'my' is part of the literal, bolded Entra admin center menu label 'APIs my organization uses'. Rewriting would misname a UI element and break accuracy. |
docs/pingcastle/4.0/enterpriseentrascan.md:134 — Netwrix.FirstPerson |
'my' is part of the literal, bolded Entra admin center menu label 'APIs my organization uses'. Rewriting would misname a UI element and break accuracy. |
docs/pingcastle/4.0/enterprisesettings-entrascanner.md:13 — Netwrix.OxfordComma |
'request and client timeouts' is a single compound list item, not a three-item series. The list already has its Oxford comma before 'and circuit breaker thresholds'. Adding a comma would be incorrect. |
docs/pingcastle/4.0/enterprisetroubleshooting.md:177 — Netwrix.OxfordComma |
'Enterprise and CloudAPI' is a two-item pairing, not a series of three, so no Oxford comma applies. False positive. |
docs/pingcastle/4.0/enterpriseemailsetup.md:615 — Dale: exclamatory-sentences |
Exclamation is inside a PowerShell Write-Host string within a code block, not prose; changing it would alter the script output. |
docs/pingcastle/4.0/enterpriseemailsetup.md:622 — Dale: exclamatory-sentences |
Exclamation is inside a PowerShell Write-Host string within a code block, not prose; changing it would alter the script output. |
docs/pingcastle/4.0/enterpriseuser.md:9 — Dale: xy-slop |
'The goal of the tool isn't perfection, but to provide reliable data' uses the negative-positive form, but the contrast is intentional expectation-setting; rewriting would drop meaningful nuance. |
docs/pingcastle/4.0/proinstall.md:8 — Dale: xy-slop |
Same 'goal isn't perfection, but to provide reliable data' framing; the contrast conveys intended scope, so rewriting risks changing meaning. |
docs/pingcastle/4.0/prouser.md:11 — Dale: xy-slop |
Same 'goal ... wasn't to aim for perfection, but to provide reliable data' framing; intentional contrast, skipped to preserve meaning. |
Ask @claude on this PR if you'd like an explanation of any fix.
…reenshots Microsoft rebranded Azure AD to Entra ID; update terminology across enterprise/pro 4.0 docs and refresh accompanying screenshots to match current UI. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…nto JD/PingCastle-4-0
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
| Category | Fixes |
|---|---|
| Dale: passive-voice | 9 |
| Dale: wordiness | 1 |
| Skipped (needs manual review) | Reason |
|---|---|
docs/pingcastle/4.0/enterpriseemailsetup.md:45 — Netwrix.TypeVsEnter |
False positive. 'The credential type' uses 'type' as a noun (a category of credential), not as an instruction to type text into a field. Changing to 'enter' would break the sentence. |
docs/pingcastle/4.0/enterpriseentrascan.md:118 — Netwrix.FirstPerson |
False positive. 'APIs my organization uses' is the literal UI menu label in the Entra admin center. Removing 'my' would misrepresent the actual UI string the user must click. |
docs/pingcastle/4.0/enterpriseentrascan.md:134 — Netwrix.FirstPerson |
False positive. 'APIs my organization uses' is the literal UI menu label in the Entra admin center. Removing 'my' would misrepresent the actual UI string the user must click. |
docs/pingcastle/4.0/enterprisesettings-entrascanner.md:13 — Netwrix.OxfordComma |
False positive. 'request and client timeouts' is a compound pair (request timeouts and client timeouts), not a third series item. The list already includes its Oxford comma before 'and circuit breaker thresholds'. |
docs/pingcastle/4.0/enterprisetroubleshooting.md:177 — Netwrix.OxfordComma |
False positive. 'If Entra ID scanning isn't available, Enterprise and CloudAPI aren't integrated correctly' is a conditional clause with a two-item subject ('Enterprise and CloudAPI'), not a three-or-more-item series requiring an Oxford comma. |
docs/pingcastle/4.0/enterpriseuser.md:9 — Dale: xy-slop |
'The goal of the tool isn't perfection, but to provide reliable data' — rephrasing to positive form would drop the intended 'not perfection' nuance; low confidence the meaning is preserved. Same construction also in proinstall.md:8 and prouser.md:11. |
docs/pingcastle/4.0/enterpriselicense.md:8 — Dale: passive-voice |
'Domain Controllers aren't counted for licensing purposes, only domains' — active rewrites either reintroduce a negative-positive contrast or shift the emphasis; not confident meaning is preserved. |
docs/pingcastle/4.0/enterprisepostinstall.md:337 — Dale: passive-voice |
'The Sync button is shown if the sync link is configured AND if the user has permission' — sentence contains multiple stacked passives and a conditional; restructuring risks altering the conditions. |
docs/pingcastle/4.0/enterprisepostinstall.md:314 — Dale: passive-voice |
Synchronization section describes system behavior with dense 'will be recomputed/forwarded' constructions; rewriting the interdependent clauses risks changing technical meaning. |
docs/pingcastle/4.0/enterpriseuser.md:235 — Dale: undefined-acronyms |
'CMMI methodology' used without expansion, but CMMI is an industry framework rather than a product-specific acronym; not confident the intended expansion is wanted. |
docs/pingcastle/4.0/prouser.md:24 — Dale: passive-voice |
prouser.md and proinstall.md contain dense legacy translated prose with many passive/awkward constructions; isolated fixes would leave surrounding text inconsistent and risk altering meaning. |
Ask @claude on this PR if you'd like an explanation of any fix.
…sages Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Auto-Fix Summary109 issues fixed, 32 skipped across 39 files
Ask |
Adds migration-verification-table image, new enterpriseschedulingmigration.md guide, and upgrade doc note that prereqs (ASP.NET Hosting Bundle) install automatically from the bundled installer without web access. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Auto-Fix Summary8 issues fixed, 22 skipped across 40 files
Ask |
RichardHNetwrix
left a comment
There was a problem hiding this comment.
I think docs\pingcastle\CLAUDE.md needs updating. Right now it says "The current version is 3.5 (only one version exists)."
…10 API Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Auto-Fix Summary35 issues fixed, 24 skipped across 40 files
Ask |
# Conflicts: # docusaurus.config.js
Documentation PR ReviewEditorial ReviewThis PR adds a full PingCastle 4.0 doc set (36 new files) plus voice/clarity edits to four existing files. Most of the new content is well structured and the cross-reference graph checks out — every relative link and anchor I spot-checked resolves. The findings below concentrate on cross-file contradictions introduced by the new 4.0 set, plus a few structural and completeness gaps. Cross-cutting issues (affect several new 4.0 files)
docs/pingcastle/4.0/index.md
docs/pingcastle/4.0/enterpriserequirements.md
docs/pingcastle/4.0/enterpriseinstall.md
docs/pingcastle/4.0/enterprisepostinstall.md
docs/pingcastle/4.0/enterpriseupgrade.md
docs/pingcastle/4.0/enterprisearchitecture.md
docs/pingcastle/4.0/enterpriseauthsetup.md
docs/pingcastle/4.0/enterprisesettings.md
docs/pingcastle/4.0/enterprisesettings-scim.md
docs/pingcastle/4.0/enterpriseagentdeployment.md
docs/pingcastle/4.0/enterpriseuser-dashboard.md
docs/pingcastle/4.0/enterpriseuser-account.md
docs/pingcastle/4.0/enterprisesynchronization.md
docs/pingcastle/4.0/proinstall.md
docs/pingcastle/4.0/prouser.md
docs/pingcastle/4.0/proupgrade.md
docs/endpointprotector/admin/systempar.md
docs/pingcastle/3.5/index.md
docs/accessanalyzer/2601/install/install-commands.md — No issues found. (The retargeted anchor docs/pingcastle/3.5/enterpriseinstall.md — No issues found. The edits are consistent voice and clarity improvements. docs/pingcastle/4.0/enterpriseauditlog.md — No issues found. docs/pingcastle/4.0/enterprisedecryptionkeys.md — No issues found. The round trip with docs/pingcastle/4.0/enterpriseemailsetup.md — No issues found beyond the cross-cutting restart contradiction noted above. docs/pingcastle/4.0/enterpriseentrascan.md — No issues found. The permissions reference is thorough and the SharePoint certificate-only constraint is well flagged in both the setup section and the permissions section. docs/pingcastle/4.0/enterprisehttpssetup.md — No issues found. docs/pingcastle/4.0/enterpriselicense.md — No issues found. docs/pingcastle/4.0/enterprisescheduling.md — No issues found beyond the cross-cutting restart contradiction noted above. docs/pingcastle/4.0/enterpriseschedulingmigration.md — No issues found. docs/pingcastle/4.0/enterprisesettings-actionplans.md — No issues found. docs/pingcastle/4.0/enterprisesettings-application.md — No issues found. docs/pingcastle/4.0/enterprisesettings-dataretention.md — No issues found. docs/pingcastle/4.0/enterprisesettings-entrascanner.md — No issues found. docs/pingcastle/4.0/enterprisesettings-logging.md — No issues found beyond the cross-cutting restart contradiction noted above. docs/pingcastle/4.0/enterprisesettings-scanningscheduling.md — No issues found beyond the cross-cutting restart contradiction noted above. docs/pingcastle/4.0/enterprisesettings-security.md — No issues found. The threshold and reset-interval explanations, with the worked example, are a good model for the other settings pages. docs/pingcastle/4.0/enterprisetroubleshooting.md — No issues found beyond the duplicate-heading pattern noted above. docs/pingcastle/4.0/enterpriseuser.md — No issues found beyond the alt-text issue noted above. docs/pingcastle/4.0/enterpriseuser-entities.md — No issues found beyond the alt-text issue noted above. docs/pingcastle/4.0/enterpriseuser-import.md — No issues found. docs/pingcastle/4.0/enterpriseuser-infrastructure.md — No issues found. Summary29 editorial suggestions across 21 files (4 of them cross-cutting across the new 4.0 set); 19 files reviewed clean. The highest-impact items are the .NET version contradiction between What to do next: Comment
You can ask Claude anything about the review or about Netwrix writing standards.
|
Auto-Fix Summary29 issues fixed, 26 skipped across 40 files
Ask |
Code ReviewScope: correctness, security, and build/routing impact only — docs content and style are handled by the other workflows. High1. PingCastle Pro docs are orphaned in 4.0 —
Because this PR also sets Either add a Pro category to the 4.0 sidebar, or drop the three files if 4.0 intentionally has no Pro tier. Medium2.
The guard this replaced in 3.
4. The script is not idempotent despite advertising With
Worse, the Low5. Lookup misses produce opaque failures —
6. OData filter injection —
7.
8. Category generation moved into the render body —
9. Derived KB version filter ignores the product it was handed — When 10. Its file table documents only the 11. Worth a second look: The script grants tenant-wide SharePoint full control (line 245) to a scanner whose other grants are all Checked and clean
|
Summary
Test plan
Closes #1278