Skip to content

Commit

Permalink
Updated name and parameters description (#2083)
Browse files Browse the repository at this point in the history
## 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>
  • Loading branch information
Saketsuraj and thomasheartman committed Sep 27, 2022
1 parent 9aa1c7a commit 501c08a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/docs/advanced/custom-activation-strategy.md
Expand Up @@ -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.

Expand Down

1 comment on commit 501c08a

@vercel
Copy link

@vercel vercel bot commented on 501c08a Sep 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

unleash – ./website

unleash-git-main-unleash-team.vercel.app
unleash-unleash-team.vercel.app
unleash-tawny.vercel.app

Please sign in to comment.