From 927b323b09ee9b4a88a283cd3e26f0f0c6b9a607 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Tue, 11 Oct 2022 16:53:28 +0200 Subject: [PATCH] docs: reorder images --- website/docs/topics/anatomy-of-unleash.mdx | 25 +++++++++++----------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/website/docs/topics/anatomy-of-unleash.mdx b/website/docs/topics/anatomy-of-unleash.mdx index 1c0efccdc7..4aae87c256 100644 --- a/website/docs/topics/anatomy-of-unleash.mdx +++ b/website/docs/topics/anatomy-of-unleash.mdx @@ -33,6 +33,8 @@ Pro and Enterprise customers can create, rename, and delete projects as they wis ## Environments and project environments +
+ [**Environments**](../user_guide/environments.md) in Unleash let you change how a feature toggle works in your application’s different environments. For instance, while you are developing a feature, it’s likely that you’ll want it to be available in the development environment, but not in the production environment: environments let you do that. You might also want to enable a feature for only some users in a production environment, but for no users in a development environment: environments let you do that. Environments exist on two different levels within Unleash. The set of **all available environments is defined on the global level**. Additionally, **each project** can choose which of these global environments should be **available on the project level**. The set of environments available to any given project is **always a subset** of the set of globally available environments. @@ -44,6 +46,9 @@ Enterprise users can create and remove environments. Open-source and Pro custome Environments are adjacent to [feature toggles](../reference/feature-toggles.mdx) in Unleash: neither one contains the other, but they come together to let you define activation strategies. + +
+ ## Features (feature toggles) [**Feature toggles**](../reference/feature-toggles.mdx) are at the heart of Unleash’s functionality. Feature toggles belong to projects and live next to project environments. In and of itself, a feature toggle doesn’t do anything. You must assign [**activation strategies**](../user_guide/activation-strategies.md) to it for it to start taking effect. @@ -52,12 +57,10 @@ When creating a feature toggle, you must assign a unique (across your Unleash in
-
- - - ## Activation strategies +
+ [**Activation strategies**](../user_guide/activation-strategies.md) (or just **strategies** for short) are the part of feature toggles that tell Unleash **who should get a feature**. An activation strategy is assigned to **one **feature toggle in **one **environment. When you check a [feature toggle](../reference/feature-toggles.mdx) in an application, the toggle’s strategies decide the result. As long as **at least one** of a toggle’s strategies resolve to true for the current context (user or application), then the toggle will be considered enabled. In other words, if you have a hundred strategies and ninety-nine of them resolve to false, but one of them resolves to true, then the toggle is enabled. @@ -66,7 +69,10 @@ Activation strategies tie feature toggles and [environments](../user_guide/envir Unleash comes with a number of strategies built in (refer the [activation strategies documentation](../user_guide/activation-strategies.md) for more information on those). You can also create your own [custom activation strategies](../advanced/custom-activation-strategy.md) if you need them. All strategies can be further augmented by [**strategy constraints**](../advanced/strategy-constraints.md). -
+ +
+ +
## Strategy constraints @@ -82,6 +88,7 @@ You can define constraints on whatever properties you want in your [Unleash cont Constraints are applied to individual strategies and do not stay in sync with each other. When you need to have the same constraints applied to multiple strategies and need those constraints to stay in sync, use [**segments**](../reference/segments.mdx). +
## Segments @@ -107,16 +114,8 @@ You can use the variant payload to attach arbitrary data to a variant. Variants A feature toggle can have as many variants as you want. Importantly, variants are independent of [environments](../user_guide/environments.md). In other words: you’ll always have the exact same variants with the exact same weightings and the exact same payloads in all environments. -
- -
-
-
- -
- ## Use case: changing website colors {#use-case} Using the concepts we have looked at in the previous sections, let’s create a hypothetical case and see how Unleash would solve it.