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

Updated name and parameters description (#2083)

Browse Source 
## Description

Updates descriptions for "name" and "parameters" fields of custom activation strategies to clarify what they are and should be used for.

## Commits

* Updated name and parameters description

* Update website/docs/advanced/custom-activation-strategy.md

Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>

* updated name's and parameter's description

Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>

Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>
This commit is contained in:
Saketsuraj 2022-09-27 17:11:32 +05:30 committed by GitHub
parent 9aa1c7aeb0
commit 501c08a4b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/docs/advanced/custom-activation-strategy.md
View File

@ -19,9 +19,9 @@ Custom activation strategies work exactly like the built-in activation strategie
You define custom activation strategies on your Unleash instance, either via the admin UI or via the API. A strategy contains:
- A strategy **name**: You'll use this to refer to the strategy in the UI and in code.
- A strategy **name**: You'll use this to refer to the strategy in the UI and in code. The strategy name should make it easy to understand what the strategy does. For instance, if a strategy uses contact numbers to determine whether a feature should be enabled, then _ContactNumbers_ would be a good name.
- An optional **description**: Use this to describe what the strategy should do.
- An optional list of **parameters**: Use this to provide the strategy with arguments it should use in its evaluation.
- An optional list of **parameters**: The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation. How you interact with them differs between SDKs, but refer to the [Node.js example in the how-to guide](../how-to/how-to-use-custom-strategies.md) for a rough idea.
The strategy **name** is the only required parameter, but adding a good **description** will make it easier to remember what a strategy should do. The list of **parameters** lets you pass data from the Unleash instance to the strategy implementation.