Skip to content

[Feature flag] Rollout of `wiki_content_editor`

Feature

This feature uses the :wiki_content_editor feature flag!

Owners / Stakeholders

The Rollout Plan

  • Rollout for beta groups
  • Rollout on GitLab.com for a certain period (how long?)

Beta Groups/Projects:

  • gitlab-org/gitlab project
  • gitlab-org/gitlab-com groups
  • ...

Expectations

What are we expecting to happen?

What might happen if this goes wrong?

What can we monitor to detect problems with this?

Rollout Timeline

Initial Rollout

Preparation Phase

  • Enable on staging (/chatops run feature set wiki_content_editor true --staging)

  • Test on staging

  • Ensure that documentation has been updated (More info)

  • Announce on the issue an estimated time this will be enabled on GitLab.com

Partial Rollout Phase

  • Enable on GitLab.com for individual groups/projects listed above and verify behaviour (/chatops run feature set --project=gitlab-org/gitlab wiki_content_editor true)

  • Verify behaviour (See Beta Groups) and add details with screenshots as a comment on this issue

Global Availability (More Info) (Please Note that Beta,Alpha and General Availability (GA) are handled on a product level and not the feature-flag)

  • Coordinate a time to enable the flag with #production and #g_delivery on slack.

  • Announce on the issue an estimated time this will be enabled on GitLab.com

  • Make the feature flag enabled by default i.e. Change default_enabled to true

  • Enable on GitLab.com by running chatops command in #production (/chatops run feature set wiki_content_editor true)

  • Announce on the issue that the flag has been enabled

  • Cross post chatops slack command to #support_gitlab-com (more guidance when this is necessary in the dev docs) and in your team channel

Cleanup

This is an important phase, that should be either done in the next Milestone or as soon as possible. For the cleanup phase, please follow our documentation on how to clean up the feature flag.

  • Announce on the issue that the flag has been enabled

  • Remove :feature_name feature flag

    • Remove all references to the feature flag from the codebase
    • Remove the YAML definitions for the feature from the repository
    • Create a Changelog Entry
  • Clean up the feature flag from all environments by running this chatops command in #production channel /chatops run feature delete wiki_content_editor.

Final Step

  • Close this rollout issue for the feature flag after the feature flag is removed from the codebase.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set --project=gitlab-org/gitlab wiki_content_editor false

Testing

Please run package-and-qa for regression purposes and to make sure existing E2Es pass with the feature flag on.

Edited by Himanshu Kapoor