Save formatting changes automatically applied by Toast UI in a separate commit
Problem
One of the most frequent points of feedback from our roll-out of the Static Site Editor in the GitLab Handbook has been the volume of changes made to the source file simply as a result of opening the page in the WYSIWYG editor. We have tried to limit this by matching the expected Markdown formatting to the documented GitLab Markdown style guide. However, the reality is that many of the pages on the GitLab handbook to not adhere strictly to this style guide.
Proposal
To avoid cluttering the changes made by the user in the Static Site Editor with the auto-formatting changes, let’s separate both changesets in different commits. This will allow users to isolate and share the specific commit containing only their changes.
This will not actually limit the number of lines of code changed in the MR.
We should also revisit the idea of pre-formatting the handbook pages to conform to our markdown style standards. Previously, when we tried this, we ran into difficulties requiring manual verification of every file.