1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website/docs/how-to/how-to-add-strategy-constraints.md
Thomas Heartman d5fbd0b743
refactor: move docs into new structure / fix links for SEO (#2416)
## What

This (admittedly massive) PR updates the "physical" documentation
structure and fixes url inconsistencies and SEO problems reported by
marketing. The main points are:

- remove or move directories : advanced, user_guide, deploy, api
- move the files contained within to the appropriate one of topics,
how-to, tutorials, or reference
- update internal doc links and product links to the content
- create client-side redirects for all the urls that have changed.

A number of the files have been renamed in small ways to better match
their url and to make them easier to find. Additionally, the top-level
api directory has been moved to /reference/api/legacy/unleash (see the
discussion points section for more on this).

## Why

When moving our doc structure to diataxis a while back, we left the
"physical' files lying where they were, because it didn't matter much to
the new structure. However, that did introduce some inconsistencies with
where you place docs and how we organize them.

There's also the discrepancies in whether urls us underscores or hyphens
(which isn't necessarily the same as their file name), which has been
annoying me for a while, but now has also been raised by marketing as an
issue in terms of SEO.

## Discussion points

The old, hand-written API docs have been moved from /api to
/reference/api/legacy/unleash. There _is_ a /reference/api/unleash
directory, but this is being populated by the OpenAPI plugin, and mixing
those could only cause trouble. However, I'm unsure about putting
/legacy/ in the title, because the API isn't legacy, the docs are. Maybe
we could use another path? Like /old-docs/ or something? I'd appreciate
some input on this.
2022-11-22 09:05:30 +00:00

2.5 KiB

title
How to add strategy constraints

:::info Availability

Before Unleash 4.16, strategy constraints were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're available to everyone.

:::

This guide shows you how to add strategy constraints to your feature toggles via the admin UI. For information on how to interact with strategy constraints from an Unleash client SDK, visit the specific SDKs documentation or see the relevant section in the strategy constraints documentation.

Prerequisites

You'll need to have an existing feature toggle with a defined strategy to add a constraint. The rest of this guide assumes you have a specific strategy that you're working with.

Step 1: Open the constraints menu

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.

On the "edit strategy" screen, select the "add constraint" button to open the constraints menu.

A feature toggle strategy view showing a button labeled with add constraints.

Step 2: Add and configure the constraint

Refer to the constraint structure section of the strategy constraints reference for a thorough explanation of the constraint fields.

  1. From the "Context Field" dropdown, select the context field you would like to constrain the strategy on and choose the constraint operator you want.
  2. Define the values to use for this constraint. The operator you selected decides whether you can define one or multiple values and what format they can have.
  3. Save the constraint first, and then save the strategy.

A strategy constraint form with a constraint set to "region". The "values" input is a dropdown menu containing the options "Africa", "Asia", "Europe", and "North America", as defined in the preceding paragraph.

How to update existing constraints

To update an existing constraint, find the constraint in the "edit strategy" screen and use the constraint's "edit" button.