feat(kno-10947) document tenancy strict mode and per-tenant guides#1242
feat(kno-10947) document tenancy strict mode and per-tenant guides#1242scoti-knock merged 4 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
||
| ## Tenancy strict mode | ||
|
|
||
| When using [audience targeting](/concepts/audiences) with guides, you may want to control how tenant membership is evaluated. Tenancy strict mode determines whether a tenant ID passed via `targetParams` must match the audience membership record for a user to see the guide. |
There was a problem hiding this comment.
TODO: Add screenshot of dashboard toggle to this section and include a line about where to enable the setting.
thomaswhyyou
left a comment
There was a problem hiding this comment.
This is really great, thank you Scoti!
My dashboard PRs haven't landed yet but will update once they are available in dashboard for screenshots.
| - **Global scope.** The guide renders once per user, regardless of which tenant they're currently in. This is ideal for feature announcements that users should only see once, like feature releases, general onboarding, and account-level user notifications. | ||
|
|
||
| - **Per-tenant scope.** The guide renders once per user-tenant pair. Users will see the guide in each tenant where they're eligible, even if they've dismissed it in another tenant. This is ideal for tenant-specific messaging like billing updates or workspace-specific onboarding. | ||
|
|
There was a problem hiding this comment.
I think it's worth mentioning that the global vs per-tenant scope can be configured when you create a guide but immutable once it's created?
Also wondering if we want to add a screenshot of the switch ui for this config?
There was a problem hiding this comment.
Yes, good call on both. I'll add in the immutable note when I add screenshots 👍
Co-authored-by: Thomas <thomas.whyyou@gmail.com>
Update guides documentation