Skip to content

Update documentation for compliance with CommonMark

What does this MR do?

Some of our documentation files will not render correctly when we upgrade from RedCarpet to CommonMark. This addresses the problem by making changes that are compatible with both RedCarpet and CommonMark. Necessary changes were determined by using the tool https://gitlab.com/digitalmoksha/diff_redcarpet_cmark

Currently docs.gitlab.com is generated using RedCarpet. The changes should allow for proper rendering on the doc site, well as when viewing the rendered markdown in the source repository (using CommonMark)

What are the relevant issue numbers?

https://gitlab.com/gitlab-org/gitlab-ce/issues/50695

Related CE MR: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/21385

Does this MR meet the acceptance criteria?

Edited by 🤖 GitLab Bot 🤖

Merge request reports