Compatibility message in content editor
Problem to solve
The Content Editor will be introduced into the Wiki without full support for every GitLab Flavored Markdown content type. Until we have full support for rendering and editing these content types, there will be some level of incompatibility with the existing Markdown editor.
This incompatibility could result in data corruption or data loss, though it will be recoverable due to the underlying git structure.
More context can be found in this meeting recording on YouTube.
Proposal
Include an alert, or some other kind of messaging on the content editor view that explains the current state of compatibility and offers a way to revert back to the "old" Markdown editor. This should probably be structured to include:
Overall description of the new editor, it's progress, and it's Beta state (not sure if we want to officially label it Beta
though)
Link to documentation that outlines specifically what content nodes are supported and what aren't. Ideally this would also have a description of how to recover from any data corruption or data loss that may occur.
A way to revert back to the old editor if something isn't rendering correctly or data is missing. This would revert the current state of the page back to its last saved version. In other words, this could be a destructive action in itself if the user has unsaved changes. We should probably treat it as such.
In the state of Content editor in action
and the user clicks on Switch to old editor
, there should be a dialog to confirm the switch because of the potential loss of changes.
Title: Are you sure you want to switch to the old editor? Body: Switching to the old editor will discard any changes you made. Primary CTA: Switch to old editor Secondary CTA: Keep editing
Another reason for this dialog is that there would be two primary CTA visible on the page while editing with the new editor. I know using an alert is something we discuss as a group so I am ok with it for now.