diff options
| author | Rémy Coutable <remy@rymai.me> | 2017-07-05 21:55:27 +0200 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2017-07-06 11:18:26 +0200 |
| commit | e5a7d1da8cfda5dc3755b6a0a1ed450415f39873 (patch) | |
| tree | 409af2c78ed74fa045562f92bc3c17a045519c72 /doc | |
| parent | 00ac76cc4ce87954d770abae411c54eb8bf23360 (diff) | |
| download | gitlab-ce-e5a7d1da8cfda5dc3755b6a0a1ed450415f39873.tar.gz | |
Improve Features API and its docs and add a Changelog item
Signed-off-by: Rémy Coutable <remy@rymai.me>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration/monitoring/performance/performance_bar.md | 13 | ||||
| -rw-r--r-- | doc/api/features.md | 4 | ||||
| -rw-r--r-- | doc/development/feature_flags.md | 3 |
3 files changed, 13 insertions, 7 deletions
diff --git a/doc/administration/monitoring/performance/performance_bar.md b/doc/administration/monitoring/performance/performance_bar.md index ae3da83bde1..409a74d2f91 100644 --- a/doc/administration/monitoring/performance/performance_bar.md +++ b/doc/administration/monitoring/performance/performance_bar.md @@ -1,7 +1,8 @@ # Performance Bar >**Note:** -Available since GitLab 9.4. +Available since GitLab 9.4. For installations from source you'll have to +configure it yourself. A Performance Bar can be displayed, to dig into the performance of a page. When activated, it looks as follows: @@ -22,8 +23,9 @@ It allows you to: ## Enable the Performance Bar -By default, the Performance Bar is disabled. You can enable it either for a -given feature group or user. +By default, the Performance Bar is disabled. You can enable it for a group +and/or users. Note that it's possible to enable it for a group and for +individual users at the same time. 1. Edit `/etc/gitlab/gitlab.rb` 1. Find the following line, and set it to the group's **full path** that should @@ -47,7 +49,10 @@ The `performance_team` feature group maps to the group specified by the curl --data "feature_group=performance_team" --data "value=true" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/features/performance_bar ``` -### Enable for a specific user +### Enable for specific users + +It's possible to enable the Performance Bar for specific users in addition to a +group, or even instead of a group: ``` curl --data "user=my_username" --data "value=true" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/features/performance_bar diff --git a/doc/api/features.md b/doc/api/features.md index 2ceea977d85..6861dbf00a2 100644 --- a/doc/api/features.md +++ b/doc/api/features.md @@ -61,8 +61,8 @@ POST /features/:name | `feature_group` | string | no | A Feature group name | | `user` | string | no | A GitLab username | -Note that `feature_group` and `user` are mutually exclusive, with -`feature_group` taking priority. +Note that you can enable or disable a feature for both a `feature_group` and a +`user` with a single API call. ```bash curl --data "value=30" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/features/new_library diff --git a/doc/development/feature_flags.md b/doc/development/feature_flags.md index cf9636eb6f6..a51adcfbd3f 100644 --- a/doc/development/feature_flags.md +++ b/doc/development/feature_flags.md @@ -13,7 +13,8 @@ During runtime you can set the values for the gates via the Starting from GitLab 9.4 we support feature groups via [Flipper groups](https://github.com/jnunemaker/flipper/blob/v0.10.2/docs/Gates.md#2-group). -Feature groups must be defined statically in `lib/feature.rb` (in the `.register_feature_groups` method), but their implementation can obviously be +Feature groups must be defined statically in `lib/feature.rb` (in the +`.register_feature_groups` method), but their implementation can obviously be dynamic (querying the DB etc.). You can see how the `performance_team` feature group for a concrete example. |