Update feature toggle targeting documentation#3115
Conversation
dylanlerch
force-pushed
the
dylan/ft-targeting-update
branch
2 times, most recently
from
7151f2a to
344e7e0
Compare
There was a problem hiding this comment.
Pull request overview
Updates the Feature Toggles “Targeting” documentation to reflect the latest targeting capabilities (minimum version, richer tenant targeting, and client rollout/segments) as part of DEVEX-210.
Changes:
- Add documentation for minimum version targeting, tenant inclusion/exclusion, tenant rollout, and client rollout/segments.
- Refresh screenshots and image metadata used by the docs site.
- Update tenant rollout image metadata and add new image metadata files; remove obsolete metadata for an old screenshot.
Reviewed changes
Copilot reviewed 7 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/pages/docs/feature-toggles/targeting.md | Expands targeting documentation to cover new targeting features and clarifies behavior/examples. |
| public/docs/img/feature-toggles/tenant-rollout.png.json | Updates tenant rollout screenshot metadata (dimensions + updated timestamp). |
| public/docs/img/feature-toggles/segments.png.json | Adds metadata for new/updated segments screenshot. |
| public/docs/img/feature-toggles/segment-add.png.json | Removes metadata for an obsolete screenshot that’s no longer referenced. |
| public/docs/img/feature-toggles/minimum-version.png.json | Adds metadata for minimum-version targeting screenshot. |
| public/docs/img/feature-toggles/included-tenants.png.json | Adds metadata for included tenants targeting screenshot. |
| public/docs/img/feature-toggles/excluded-tenants.png.json | Adds metadata for excluded tenants targeting screenshot. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Have given this a second read-over in preview mode and it's looking good 😄 |
|
|
||
| Tenant rollout allows you to enable a toggle for a random percentage of all tenants. | ||
|
|
||
| The included tenants are determined using a MurmurHash of the tenant ID and a toggle-specific key. This guarantees deterministic evaluation for any given tenant and toggle combination, while ensuring that a different set of tenants is included for each toggle. |
There was a problem hiding this comment.
toggle-specific key
Note to update after rollout groups goes out?
There was a problem hiding this comment.
I'll likely keep this as it currently is once we release rollout groups. At this point in the documentation I don't want people to have to understand rollout groups, just that every toggle will be evaluated differently.
I'll use the rollout group section to explain that you can link this between feature toggles.
| If you are not running the required minimum version of these libraries, the rollout percentage will be ignored (and handled as if the value was set to 100%). | ||
| ::: | ||
|
|
||
| ### Segments {#segments} |
There was a problem hiding this comment.
I can't recall, but did we say that at some point we should call out that segments are sent to clients so shouldn't contain sensitive values?
There was a problem hiding this comment.
I can't recall either. Keen to get this merged so I won't add this now. I'm not against having it in here.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
dylanlerch
force-pushed
the
dylan/ft-targeting-update
branch
from
6aa9088 to
4bc7498
Compare
Updates feature toggle targeting documentation to cover all of the latest targeting features. Part of DEVEX-210.