[Feature flag] Enable Switch between editing in Content Editor and raw Markdown
Summary
This issue is to rollout Switch between editing in Content Editor and raw Markdown on production,
that is currently behind the wiki_switch_between_content_editor_raw_markdown
feature flag.
This feature allows
Related issues
Owners
- Team: @gl-editor
- Most appropriate slack channel to reach out to:
#g_create_editor
- Best individual to reach out to: @ealcantara @himkp
- PM: @ericschurter
Stakeholders
Expectations
What are we expecting to happen?
This section describes the current behavior of editing Markdown in the Wiki and the new behavior after enabling the feature flag.
Current behavior
We will change the mechanism to switch between the Content Editor and the Classic Markdown Editor in Wikis. Currently, the Wiki edit page displays a prompt to encourage the user to try the Content Editor. This prompt can’t be permanently dismissed.
When switching back to the Classic Markdown Editor, the Wiki edit form doesn’t preserve the changes in the Content Editor and rolls back to the unmodified markdown that was loaded from the backend.
New Behavior
- The user toggles between the Classic Markdown Editor and the Content Editor by clicking the "Switch to rich text" / "Edit source" link buttons.
- The Wiki edit form will save the last editor chosen by the user as a web browser preference in local storage.
Screenshots
Before | After |
---|---|
What might happen if this goes wrong?
- The main risk with this change is that the user may report unexpected changes in the Wiki page’s content when switching between the Content Editor and the Classic Markdown Editor.
- The user may report that the default editor is not their preferred choice.
We can rollback the feature flag and switch to the previous approach to switch between the Content Editor and Classic Markdown editor.
What can we monitor to detect problems with this?
- Stay alert to reports in the Content Editor feedback issue
Rollout Steps
Rollout on non-production environments
- Ensure that the feature MRs have been deployed to non-production environments.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set wiki_switch_between_content_editor_raw_markdown true --dev
-
/chatops run feature set wiki_switch_between_content_editor_raw_markdown true --staging
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable.
Specific rollout on production
- Ensure that the feature MRs have been deployed to both production and canary.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
- If you're using group-actor, you must enable the feature on these entries:
-
/chatops run feature set --group=gitlab-org wiki_switch_between_content_editor_raw_markdown true
-
/chatops run feature set --group=gitlab-com wiki_switch_between_content_editor_raw_markdown true
-
-
Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable.
Preparation before global rollout
-
Check if the feature flag change needs to be accompanied with a change management issue. Cross link the issue here if it does. -
Ensure that you or a representative in development can be available for at least 2 hours after feature flag updates in production. If a different developer will be covering, or an exception is needed, please inform the oncall SRE by using the @sre-oncall
Slack alias. -
Ensure that documentation has been updated (More info). -
Announce on the feature issue an estimated time this will be enabled on GitLab.com. -
If the feature might impact the user experience, notify #support_gitlab-com
and your team channel (more guidance when this is necessary in the dev docs).
Global rollout on production
For visibility, all /chatops
commands that target production should be:
-
Executed in the
#production
slack channel. -
Cross-posted (with the command results) to the responsible team's slack channel (
#g_TEAM_NAME
). -
Incrementally roll out the feature. - If the feature flag in code has an actor, perform actor-based rollout.
-
/chatops run feature set wiki_switch_between_content_editor_raw_markdown <rollout-percentage> --actors
-
- If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
-
/chatops run feature set wiki_switch_between_content_editor_raw_markdown <rollout-percentage>
-
- Enable the feature globally on production environment.
-
/chatops run feature set wiki_switch_between_content_editor_raw_markdown true
-
- If the feature flag in code has an actor, perform actor-based rollout.
-
Announce on the feature issue that the feature has been globally enabled.
Release the feature
After the feature has been deemed stable, the clean up should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase.
-
Create a merge request to remove <feature-flag-name>
feature flag. Ask for review and merge it.-
Remove all references to the feature flag from the codebase. -
Remove the YAML definitions for the feature from the repository. -
Create a changelog entry.
-
-
Ensure that the cleanup MR has been deployed to both production and canary. If the merge request was deployed before the code cutoff, the feature can be officially announced in a release blog post. -
/chatops run auto_deploy status <merge-commit-of-cleanup-mr>
-
-
Close the feature issue to indicate the feature will be released in the current milestone. -
Clean up the feature flag from all environments by running these chatops command in #production
channel:-
/chatops run feature delete wiki_switch_between_content_editor_raw_markdown --dev
-
/chatops run feature delete wiki_switch_between_content_editor_raw_markdown --staging
-
`/chatops run feature delete wiki_switch_between_content_editor_raw_markdown
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set wiki_switch_between_content_editor_raw_markdown false
Availability and Testing
Please assign the SET (@a_mcdonald) to the MR that removes the feature flag as we will need to remove the ff flow from the content_editor_spec
E2E test (see #346149 (closed) for more details) to prevent it from breaking in pipelines.