diff options
| author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2020-12-15 19:22:55 +0300 |
|---|---|---|
| committer | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2020-12-17 16:02:29 +0300 |
| commit | 40f953069d4d762f489da2c160fae7c97df478ba (patch) | |
| tree | 008604e2c2cdaa6c099b06c0b122a8603b85e401 /.gitlab | |
| parent | 17c95dc4bf0ae018a986d180aa131e0099fca1fe (diff) | |
Feature flag rollout doc: rewrite & make better use of template
Rather than duplicating things between the issue template and process
doc, let's cross link the two.
Also elaborate on a lot of things I encountered when enabling my first
features. This is the result of feedback on the initial version of
this [1] and a video chat with @zj-gitlab this morning.
1. https://gitlab.com/gitlab-org/gitaly/-/merge_requests/2910
Diffstat (limited to '.gitlab')
| -rw-r--r-- | .gitlab/issue_templates/Feature Flag Roll Out.md | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/.gitlab/issue_templates/Feature Flag Roll Out.md b/.gitlab/issue_templates/Feature Flag Roll Out.md index b214f302c..e925767d7 100644 --- a/.gitlab/issue_templates/Feature Flag Roll Out.md +++ b/.gitlab/issue_templates/Feature Flag Roll Out.md @@ -20,7 +20,21 @@ Enable the `:feature_name` feature flag ... ### What can we monitor to detect problems with this? -<!-- Which dashboards from https://dashboards.gitlab.net are most relevant? --> +<!-- + +Which dashboards from https://dashboards.gitlab.net are most relevant? +Usually you'd just like a link to the method you're changing in the +dashboard at: + +https://dashboards.gitlab.net/d/000000199/gitaly-feature-status + +I.e. + +1. Open that URL +2. Change "method" to your feature, e.g. UserDeleteTag +3. Copy/paste the URL & change gprd to gstd to monitor staging as well as prod + +--> ## Beta groups/projects @@ -32,14 +46,15 @@ If applicable, any groups/projects that are happy to have this feature turned on ## Roll Out Steps -- [ ] [Read the documentation of feature flags](https://docs.gitlab.com/ee/development/rolling_out_changes_using_feature_flags.html) +- [ ] [Read the documentation of feature flags](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/PROCESS.md#feature-flags) - [ ] Add ~"featureflag::staging" to this issue -- [ ] Enable on staging -- [ ] Test on staging +- [ ] Is the required code deployed? ([howto](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/PROCESS.md#is-the-required-code-deployed)) +- [ ] Enable on staging ([howto](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/PROCESS.md#enable-on-staging)) +- [ ] Test on staging ([howto](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/PROCESS.md#test-on-staging)) - [ ] Ensure that documentation has been updated -- [ ] Announce on the issue an estimated time this will be enabled on GitLab.com +- [ ] Announce on this issue an estimated time this will be enabled on GitLab.com - [ ] Add ~"featureflag::production" to this issue -- [ ] Enable on GitLab.com by running chatops command in `#production` +- [ ] Enable on GitLab.com by running chatops command in `#production` ([howto](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/PROCESS.md#enable-in-production)) - [ ] Cross post chatops slack command to `#support_gitlab-com` and in your team channel - [ ] Announce on the issue that the flag has been enabled - [ ] Remove feature flag and add changelog entry |