Rollout GitLab UI tooltips
What
Remove the :gl_tooltips
feature flag.
Owners
- Team: ~"group::editor"
- Most appropriate slack channel to reach out to:
#g_create_editor
- Best individual to reach out to: @ealcantara
Expectations
What are we expecting to happen?
All tooltips in the GitLab application will be instances of the GitLab UI tooltip component. Currently, tooltips are instances of the Bootstrap tooltip component.
What might happen if this goes wrong?
Tooltips may not look as expected in the application. The tooltips will fallback to the web browser’s native title tooltip. This consequence does not represent a blocking situation for users.
What can we monitor to detect problems with this?
- JavaScript errors reported to Sentry.
- Since the problems that could arise from enabling this feature flag impact UX in the application, we can monitor internal feedback in the #support_gitlab-com and
#is_this_known
Slack channels.
Beta groups/projects
If applicable, any groups/projects that are happy to have this feature turned on early. Some organizations may wish to test big changes they are interested in with a small subset of users ahead of time for example.
- none
This feature has been successfully verified on the staging and dev environments.
Roll Out Steps
-
Confirm that QA tests pass with the feature flag enabled (if you're unsure how, contact the relevant stable counterpart in the Quality department) -
Enable on staging ( /chatops run feature set feature_name true --staging
) -
Test on staging -
[ ] Ensure that documentation has been updatedThis is a UX improvement that does not require user-facing documentation. -
Enable on GitLab.com for individual groups/projects listed above and verify behaviour ( /chatops run feature set --project=gitlab-org/gitlab feature_name true
) -
Coordinate a time to enable the flag with the SRE oncall and release managers - In
#production
mention@sre-oncall
and@release-managers
. Once an SRE on call and Release Manager on call confirm, you can proceed with the rollout
- In
-
Announce on the issue an estimated time this will be enabled on GitLab.com -
Enable on GitLab.com by running chatops command in #production
(/chatops run feature set feature_name true
) -
Cross post chatops Slack command to #support_gitlab-com
(more guidance when this is necessary in the dev docs) and in your team channel -
Announce on the issue that the flag has been enabled -
Remove feature flag and add changelog entry -
After the flag removal is deployed, clean up the feature flag by running chatops command in #production
channel
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set gl_tooltips false
Edited by Enrique Alcántara