Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-20 00:08:02 +01:00
Code Issues Projects Releases Wiki Activity

docs: document how segment conflicts are handled (#5577)

Browse Source 
As discovered in the recent segments breakathon, the docs aren't very
clear about how conflicts are handled. This PR better documents when
they can't be deleted or moved. It also mentions the edge case where a
segment is used in an archived flag (it still can't be deleted, so you
must either delete the flag, or revive it and remove the segment)
This commit is contained in:
Thomas Heartman 2023-12-11 11:47:23 +01:00 committed by GitHub
parent 5d80f5fa4d
commit 0060697c01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
website/docs/reference/segments.mdx
View File

@ -13,7 +13,7 @@ was made available for Open Source from Unleash v5.5.
<VideoContent videoUrls={["https://www.youtube.com/embed/LWMCCFcRic0"]}/> <VideoContent videoUrls={["https://www.youtube.com/embed/LWMCCFcRic0"]}/>
A **segment** is a reusable collection of [strategy constraints](../reference/strategy-constraints.md). Like with strategy constraints, you apply segments to [feature toggle activation strategies](../reference/activation-strategies.md). A **segment** is a reusable collection of [strategy constraints](../reference/strategy-constraints.md). Like with strategy constraints, you apply segments to [feature flag activation strategies](../reference/activation-strategies.md).
You can apply the same segment to multiple activation strategies. If you update the segment, the changes will affect every strategy that uses that segment. You can apply the same segment to multiple activation strategies. If you update the segment, the changes will affect every strategy that uses that segment.
@ -24,11 +24,13 @@ Segments let you create user groups based on data available in the Unleash conte
- Users who signed up before a specific point in time - Users who signed up before a specific point in time
- ... Or any combination of the above. - ... Or any combination of the above.
Because segments stay in sync across strategies, any changes will propagate to all the activation strategies that use them. This also makes them ideal for use cases such as activating or deactivating multiple feature toggles at the same time. In other words, you can use segments to Because segments stay in sync across strategies, any changes will propagate to all the activation strategies that use them. This also makes them ideal for use cases such as activating or deactivating multiple feature flags at the same time. In other words, you can use segments to
- release one or more new features at a specified time - release one or more new features at a specified time
- create events with start and end times and guarantee that features will only be active during that period - create events with start and end times and guarantee that features will only be active during that period
Segments can be global or scoped to a specific project. If a segment is scoped to a single project, it can only be used in that project and it adheres to that project's [change request](change-requests.md#change-request-for-segments "change requests for segments") settings.
## Structure and evaluation ## Structure and evaluation
Segments are collections of strategy constraints. To satisfy a segment, _all_ the constraints in the collection must be satisfied. Segments are collections of strategy constraints. To satisfy a segment, _all_ the constraints in the collection must be satisfied.
@ -59,8 +61,16 @@ This means that if you want to add a hundred different user IDs to one of your c
## Creating, updating, and deleting segments ## Creating, updating, and deleting segments
:::info
Currently in development, Unleash will soon count segments as being in use when they are used in [change requests](change-requests.md).
:::
Segments can be created, edited, and deleted from the segments page in the admin UI or via the API (see the [segments API documentation](/reference/api/legacy/unleash/admin/segments.mdx)). Segments can be created, edited, and deleted from the segments page in the admin UI or via the API (see the [segments API documentation](/reference/api/legacy/unleash/admin/segments.mdx)).
A segment that is in use **cannot** be deleted. If you'd like to delete a segment that is in use, you must first remove the segment from all the activation strategies that are currently using it. A segment that is in use cannot be deleted. If you'd like to delete a segment that is in use, you must first remove the segment from all the activation strategies that are currently using it. If a segment is in use by an archived flag, you must either unarchive the flag and remove the segment or delete the flag entirely before the segment can be deleted.
A segment that is in use in multiple projects can not be turned into a project-level segment. Further, a segment that is in use in project A cannot be turned into a project-level segment in project B.
![The Segments page, listing two existing segments: "Mobile users" and "Users in the APAC region". The navigation menu with the Segments page link is opened and highlighted to provide navigation help.](/img/segments-page.png) ![The Segments page, listing two existing segments: "Mobile users" and "Users in the APAC region". The navigation menu with the Segments page link is opened and highlighted to provide navigation help.](/img/segments-page.png)