1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00

docs: Update docs with new constraint availability (#2113)

* docs: fix duplicated image.

* docs: add announcement banner for constraints

* docs: style announcement bar via CSS

* docs: update doc availability notices

* docs: remove commented-out announcement bar code
This commit is contained in:
Thomas Heartman 2022-10-04 14:13:52 +02:00 committed by GitHub
parent 688ca2c53f
commit 0e4734af38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 27 additions and 5 deletions

View File

@ -4,13 +4,18 @@ title: Strategy Constraints
---
:::info Availability
Strategy constraints are available to Unleash Pro and Enterprise users.
Before Unleash 4.16, strategy constraints were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**.
Unleash 4.9 introduced a more comprehensive set of constraint operators. These require that both Unleash *and* your client SDK of choice support them. See the [SDK compatibility table](../sdks/index.md#strategy-constraints) for more information. Prior to Unleash 4.9, the only available operators were `IN` and `NOT_IN`.
:::
:::caution undefined behavior
When using _advanced strategy constraints_ (any operator that isn't `IN` or `NOT_IN`), *make sure your client SDK is up to date* and supports this feature. For older versions of the client SDKs we **cannot guarantee** any specific behavior. Please see the [incompatibilities section](#incompatibilities) for more information.
:::
**Strategy constraints** are conditions that must be satisfied for an [activation strategy](../user_guide/activation_strategy) to be evaluated for a feature toggle.

View File

@ -4,7 +4,7 @@ title: How to add strategy constraints
:::info Availability
Strategy constraints are available to Unleash Pro and Enterprise users.
Before Unleash 4.16, strategy constraints were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**.
:::
@ -18,7 +18,7 @@ You'll need to have an existing feature toggle with a defined strategy to add a
On the strategy you're working with, find and select the "edit strategy" button.
![A feature toggle with one strategy. The "edit strategy" button is highlighted.](/img/add-constraint.png)
![A feature toggle with one strategy. The "edit strategy" button is highlighted.](/img/create-toggle-edit-strategy.png)
On the "edit strategy" screen, select the "add constraint" button to open the constraints menu.

View File

@ -3,7 +3,10 @@ title: How to define custom context fields
---
:::info Availability
Custom context fields are available to Pro and Enterprise users. They were introduced in Unleash 3.2.28.
Before Unleash 4.16, custom context fields were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**. They were introduced in Unleash 3.2.28.
:::
This guide shows you how to create [custom context field for the Unleash Context](../user_guide/unleash-context.md#custom-context-fields). You can use custom context fields for [strategy constraints](../advanced/strategy-constraints.md) and for [custom stickiness calculations](../advanced/stickiness.md#custom-stickiness). If there are [standard Unleash Context fields](../user_guide/unleash-context.md#structure) missing from the context fields page, you can use the same steps to add them too.

View File

@ -44,7 +44,9 @@ As an example: You've created a custom field called `groupId`. You know group ID
## Custom context fields
:::info Availability
Custom context fields are available to Pro and Enterprise users.
Before Unleash 4.16, custom context fields were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**. They were introduced in Unleash 3.2.28.
:::
Custom context fields allow you to extend the Unleash Context with more data that is applicable to your situation. Each context field definition consists of a name and an optional description. Additionally, you can choose to define a set of [_legal values_](#legal-values "legal values for custom context fields"), and you can choose whether or not the context field can be used in [custom stickiness calculations](../advanced/stickiness.md#custom-stickiness) for the [gradual rollout strategy](activation-strategies.md#customize-stickiness-beta) and for [feature toggle variants](../advanced/feature-toggle-variants.md).

View File

@ -26,6 +26,12 @@ module.exports = {
apiKey: '9772249a7262b377ac876853d32bd760',
indexName: 'getunleash',
},
announcementBar: {
id: 'strategy-constraints-announcement',
content:
'🚀 Unleash brings powerful Constraints feature to OSS users. <a href=https://www.getunleash.io/blog/unleash-brings-powerful-constraints-feature-to-oss-users title="Unleash blog: Constraints are now available to open-source users">Read more</a> →',
isCloseable: true,
},
navbar: {
title: 'Unleash',
logo: {

View File

@ -63,6 +63,12 @@ html[data-theme='dark'] {
--docsearch-primary-color: var(--ifm-color-primary-darkest);
}
div[class^='announcementBar_'],
div[class^='announcementBar_'] svg {
background-color: var(--ifm-color-primary);
color: var(--ifm-color-primary-contrast-background);
}
.visually-hidden {
border: 0;
clip: rect(0 0 0 0);