From 1120543a3d15a6949cf004135155bd3c820f4210 Mon Sep 17 00:00:00 2001 From: Irina Southwell Date: Sun, 19 Nov 2023 10:14:28 +1300 Subject: [PATCH] docs for FG (#1087) --- docs/modules/ROOT/pages/feature-groups.adoc | 9 +++++++++ docs/modules/ROOT/pages/users.adoc | 9 +++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/modules/ROOT/pages/feature-groups.adoc b/docs/modules/ROOT/pages/feature-groups.adoc index 26555ad4d..60d70e0dd 100644 --- a/docs/modules/ROOT/pages/feature-groups.adoc +++ b/docs/modules/ROOT/pages/feature-groups.adoc @@ -40,3 +40,12 @@ image::fg-dashboard-view.png[Feature Group features console view, 1500] Yes, the same feature can be added to multiple groups. It means that a feature will have multiple strategies applied to it, so you can assign multiple values. For example, this could be useful, when you want to serve a feature but with different feature value depending on a different customer segment. As every feature value you set in the groups is always visible from the main dashboard, it is easy to see all the strategies assigned. The order of the strategies will appear in the same order as the order of feature groups on "Feature Groups" screen. In the future, we will provide ability to reorder them. image::fg-view-from-dashboard.png[Feature Group values view from Console, 1500] + +== Feature Groups and User Permissions to set/update groups +Permissions for Feature Groups are set per environment and controlled by the Feature Value level permissions. + +* `READ` permission allows to view Feature Groups and settings for features and a strategy inside a group +* `CHANGE_VALUE` permission allows +to create, edit and delete Feature Groups for a given environment. As well as change a feature value, create and update strategy in a Feature Group. + +NOTE: See link:users#_group_permissions[Groups Permissions] for details on the various permission states a feature can have. diff --git a/docs/modules/ROOT/pages/users.adoc b/docs/modules/ROOT/pages/users.adoc index 48067a1e5..189609d91 100644 --- a/docs/modules/ROOT/pages/users.adoc +++ b/docs/modules/ROOT/pages/users.adoc @@ -67,12 +67,17 @@ NOTE: Once feature is created, feature values will be automatically created with Following permissions are to control feature values and can be set per each environment for a given application: -* `READ` Can see the value of a feature, feature value strategies assigned, feature properties, lock/unlock status, retirement status and feature auditing +* `READ` +** Can view the value of a feature, feature value strategies assigned, feature properties, lock/unlock status, retirement status and feature auditing +** Can view Feature Groups and settings for features and a strategy inside a group * `LOCK` Can lock a feature, so it's value can't be changed, this gives us a safety net when deploying incomplete code into production. (Typically, developers and testers keep features locked until they are finished and ready to be set by business people) * `UNLOCK` Can unlock a feature, so it's value can be changed -* `CHANGE_VALUE` Can change the value of a feature or can "retire" a feature +* `CHANGE_VALUE` +** Can change the value of a feature or can "retire" a feature. +** Can create, set and delete strategy on a feature. +** Can create, edit and delete feature groups for a given environment. Can change a feature value, create and update strategy in a Feature Group. image::fh-group-permissions.png[Group permissions, 1500]