diff --git a/README.md b/README.md index f06013b2a7..86ae55507e 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ This repo contains the unleash-server, which contains the admin UI and a place t In order to make use of unleash you will also need a client implementation. -![2016-12-28-211658_1115x752_scrot](https://github.com/Unleash/unleash/raw/master/docs/2017-02-06-130615_942x802_scrot.png) +![Unleash UI](https://github.com/Unleash/unleash/raw/master/docs/assets/dashboard.png) Online demo [version availble on heroku](https://unleash-new-ui.herokuapp.com/#/features). diff --git a/docs/2017-02-06-130615_942x802_scrot.png b/docs/2017-02-06-130615_942x802_scrot.png deleted file mode 100644 index ee47ac8db6..0000000000 Binary files a/docs/2017-02-06-130615_942x802_scrot.png and /dev/null differ diff --git a/docs/activation-strategies.md b/docs/activation-strategies.md index 5f486d49a3..777e477313 100644 --- a/docs/activation-strategies.md +++ b/docs/activation-strategies.md @@ -18,11 +18,13 @@ Active for users with a userId defined in the userIds-list. Typically I want to ## gradualRolloutUserId Gradually activate feature toggle for logged in users. Stickiness based on user id. This strategy guarantees that the same user gets the same experience every time, -across devices. It also guarantees that a user which is among the first 10% will also -be among 20% roll-out degree. Thus we ensure that users gets the same experience, -even if we gradually increase the number of users we expose the feature to. To -achieve this we use a hash-algorithm where we normalize the user-id to a number -between 1 and 100. +across devices. It also guarantees that a user which is among the first 10% will +also be among the first 20% of the users. Thus we ensure that users get the same +experience. Even if we gradually increase the number of users who are exposed to +a particular feature. To achieve this we hash the user id and normalise the hash +value to a number between 1 and 100 with a simple modulo operator. + +![hash_and_normalise](assets/hash_and_normalise.png) **Parameters** - percentage - *The percentage (0-100) you want to enable to feature toggle for.* diff --git a/docs/assets/dashboard.png b/docs/assets/dashboard.png new file mode 100644 index 0000000000..c12bb83876 Binary files /dev/null and b/docs/assets/dashboard.png differ diff --git a/docs/assets/hash_and_normalise.png b/docs/assets/hash_and_normalise.png new file mode 100644 index 0000000000..a0580cd5e9 Binary files /dev/null and b/docs/assets/hash_and_normalise.png differ