From 99b27061aae9d77f8fd62f1ac993b39b9ba410ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivar=20Conradi=20=C3=98sthus?= Date: Mon, 10 Aug 2020 10:10:41 +0200 Subject: [PATCH] fix: update feature toggle variants documentation --- ...-features.md => feature-toggle-variants.md} | 18 +++--------------- website/sidebars.json | 4 ++-- 2 files changed, 5 insertions(+), 17 deletions(-) rename docs/{beta-features.md => feature-toggle-variants.md} (60%) diff --git a/docs/beta-features.md b/docs/feature-toggle-variants.md similarity index 60% rename from docs/beta-features.md rename to docs/feature-toggle-variants.md index 0297795d34..9aea544519 100644 --- a/docs/beta-features.md +++ b/docs/feature-toggle-variants.md @@ -1,15 +1,11 @@ --- -id: beta_features -title: Beta Features +id: toggle_variants +title: Feature Toggle Variants --- -## Beta Features - -In this section, we will introduce the beta features available in Unleash. These features are considered stable enough to use in production, but they are subject to change in later versions in Unleash. You must, therefore, take extra care updating Unleash if you depend on these features. - ### Feature Toggle Variants -> This feature was introduced in _Unleash v3.2.0_. To enable this feature, you must create a new feature toggle named `unleash.beta.variants` and make sure to enable it. +> This feature was introduced in _Unleash v3.2.0_. Do you want to facilitate more advanced experimentations? Do you want to use Unleash to handle your A/B experiments? Say hello to feature toggle variants! @@ -34,8 +30,6 @@ Variant variant = unleash.getVariant("toggle.name", unleashContext); System.out.println(variant.getName()); ``` -### Payload - #### Client SDK Support To make use of toggle variants, you need to use a compatible client. Client SDK with variant support: @@ -45,10 +39,4 @@ To make use of toggle variants, you need to use a compatible client. Client SDK - [unleash-client-ruby](https://github.com/Unleash/unleash-client-ruby) (from v0.1.6) - [unleash-client-python](https://github.com/Unleash/unleash-client-python) (from v3.3.0) -#### Limitations - -- Currently, you can not set the variant weights yourself. The plan is to make this customizable. To have it stable over time the total weights need to be stable, and we have currently defined the sum to be 100, meaning we have 100 slots to spread the traffic. -- You are only able to provide overrides based on `userId`. This allows you to control which variant a specific user should get. In the future, you will be able to define overrides on all context parameters. -- The payload only supports `type=string`. This might change in the future. For now, you can pass an optional string payload to the client. Your application is responsible for parsing it correctly depending on the format, e.g. JSON, CSV, etc. - If you would like to give feedback on this feature, experience issues or have questions, please feel free to open an issue on [GitHub](https://github.com/Unleash/unleash/). diff --git a/website/sidebars.json b/website/sidebars.json index 725dfb2859..31aca7c269 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -4,12 +4,12 @@ "getting_started", "client_sdk", "feature_toggle_types", + "toggle_variants", "securing_unleash", "unleash_context", "activation_strategy", "client_specification", - "migration_guide", - "beta_features" + "migration_guide" ], "Developer Guide": [ "developer_guide",