Skip to content

Commit 1120543

Browse files
authored
docs for FG (#1087)
1 parent eb6c090 commit 1120543

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

docs/modules/ROOT/pages/feature-groups.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,12 @@ image::fg-dashboard-view.png[Feature Group features console view, 1500]
4040
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.
4141

4242
image::fg-view-from-dashboard.png[Feature Group values view from Console, 1500]
43+
44+
== Feature Groups and User Permissions to set/update groups
45+
Permissions for Feature Groups are set per environment and controlled by the Feature Value level permissions.
46+
47+
* `READ` permission allows to view Feature Groups and settings for features and a strategy inside a group
48+
* `CHANGE_VALUE` permission allows
49+
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.
50+
51+
NOTE: See link:users#_group_permissions[Groups Permissions] for details on the various permission states a feature can have.

docs/modules/ROOT/pages/users.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,17 @@ NOTE: Once feature is created, feature values will be automatically created with
6767

6868
Following permissions are to control feature values and can be set per each environment for a given application:
6969

70-
* `READ` Can see the value of a feature, feature value strategies assigned, feature properties, lock/unlock status, retirement status and feature auditing
70+
* `READ`
71+
** Can view the value of a feature, feature value strategies assigned, feature properties, lock/unlock status, retirement status and feature auditing
72+
** Can view Feature Groups and settings for features and a strategy inside a group
7173
* `LOCK` Can lock a feature, so it's value can't be changed, this gives us a
7274
safety net when deploying incomplete code into production.
7375
(Typically, developers and testers keep features locked until they are finished and ready to be set by business people)
7476
* `UNLOCK` Can unlock a feature, so it's value can be changed
75-
* `CHANGE_VALUE` Can change the value of a feature or can "retire" a feature
77+
* `CHANGE_VALUE`
78+
** Can change the value of a feature or can "retire" a feature.
79+
** Can create, set and delete strategy on a feature.
80+
** Can create, edit and delete feature groups for a given environment. Can change a feature value, create and update strategy in a Feature Group.
7681

7782
image::fh-group-permissions.png[Group permissions, 1500]
7883

0 commit comments

Comments
 (0)