Apply consistent Markdown format to handbook’s product section pages

As part of the effort to configure the Static Site Editor in the Handbook, we are starting by including a Static Site Editor in the handbook’s product section pages. In our internal tests, we observed that the Static Site Editor, via the Toast UI dependency, automatically reformats a page’s Markdown Source which, in turn, pollutes the Merge Requests creating with the editor.

To avoid this situation, we have to preformat the product section’s pages with formatting preferences that match Toast UI as much as possible.

Formatting preferences

• Emphasis character: _
• Strong character: *
• List bullet char: -
• list indent space: 4 spaces
• increment ordered lists: false

Files to format

These are the files we have to format. We have to determine if the scope is too large:

• sites/handbook/source/handbook/product/product-principles/index.html.md.erb - ⚠ MR
• sites/handbook/source/handbook/product/investment/index.html.md.erb - 🚫
• sites/handbook/source/handbook/product/product-categories/plan/index.html.md.erb - 🚫
• sites/handbook/source/handbook/product/product-categories/ops/index.html.md.erb - 🚫
• sites/handbook/source/handbook/product/product-categories/index.html.md.erb - MR
• sites/handbook/source/handbook/product/performance-indicators/index.html.md.erb - 👍 no formatting needed (include)
• sites/handbook/source/handbook/product/ops-section-performance-indicators/index.html.md.erb - 👍 no formatting needed (include)
• sites/handbook/source/handbook/product/product-manager-role/index.html.md.erb - MR
• sites/handbook/source/handbook/product/secure-and-defend-section-performance-indicators/index.html.md.erb - 👍 no formatting needed (include)
• sites/handbook/source/handbook/product/enablement-section-performance-indicators/index.html.md.erb - 👍 no formatting needed (include)
• sites/handbook/source/handbook/product/use-cases/index.html.md.erb - 👍 no formatting needed
• sites/handbook/source/handbook/product/product-management/walk-throughs/ops-section/index.html.md.erb - MR
• sites/handbook/source/handbook/product/product-management/walk-throughs/index.html.md.erb - MR
• sites/handbook/source/handbook/product/gitlab-the-product/index.html.md.erb - MR
• sites/handbook/source/handbook/product/application-types/index.html.md.erb - 🚫 MR
• sites/handbook/source/handbook/product/administration/index.html.md.erb Removed and redirected
• sites/handbook/source/handbook/product/product-processes/index.html.md.erb - MR
• sites/handbook/source/handbook/product/dev-section-performance-indicators/index.html.md.erb - 👍 no formatting needed (include)
• sites/handbook/source/handbook/product/index.html.md.erb - MR
• sites/handbook/source/handbook/product/product-leadership/index.html.md - MR
• sites/handbook/source/handbook/product/how-to-engage/index.html.md - ⚠ MR
• sites/handbook/source/handbook/product/making-gifs/index.html.md - MR
• sites/handbook/source/handbook/product/readme/adam-smolinski.html.md - MR
• sites/handbook/source/handbook/product/readme/scott-williamson.html.md - MR
• sites/handbook/source/handbook/product/readme/index.html.md - MR
• sites/handbook/source/handbook/product/readme/tim-hey.html.md - MR
• sites/handbook/source/handbook/product/readme/joshua-lambert.md No content
• sites/handbook/source/handbook/product/readme/eric-brinkman.html.md - MR
• sites/handbook/source/handbook/product/readme/jeremy-watson.html.md - MR
• sites/handbook/source/handbook/product/readme/jason-yavorska.html.md - 👍 no formatting needed
• sites/handbook/source/handbook/product/growth/index.html.md - MR
• sites/handbook/source/handbook/product/growth/expansion/index.html.md - MR
• sites/handbook/source/handbook/product/internship/index.html.md - MR
• sites/handbook/source/handbook/product/milestones/index.html.md - 👍 no formatting needed (Closed MR)
• sites/handbook/source/handbook/product/single-application/index.html.md - ⚠ MR
• sites/handbook/source/handbook/product/single-application/dataflow.html.md - MR
• sites/handbook/source/handbook/product/survey/index.html.md - MR
• sites/handbook/source/handbook/product/i2p-demo/index.html.md - 👍 no formatting needed

Technical decisions

We haven’t discussed the technical approach to apply preformatting yet although the markdown-formatter came up as a potential solution.