From 501c08a4b18e97f2c50161688d075839c64e1c97 Mon Sep 17 00:00:00 2001 From: Saketsuraj <35957533+Saketsuraj@users.noreply.github.com> Date: Tue, 27 Sep 2022 17:11:32 +0530 Subject: [PATCH] Updated name and parameters description (#2083) ## 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 * updated name's and parameter's description Co-authored-by: Thomas Heartman Co-authored-by: Thomas Heartman --- website/docs/advanced/custom-activation-strategy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/advanced/custom-activation-strategy.md b/website/docs/advanced/custom-activation-strategy.md index 720152dc78..876c1e7f22 100644 --- a/website/docs/advanced/custom-activation-strategy.md +++ b/website/docs/advanced/custom-activation-strategy.md @@ -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.