Skip to content

Fix master-broken triage documentation formatting

David Dieulivol requested to merge ddieulivol-fix_docs_formatting into master

Why is this change being made?

The https://about.gitlab.com/handbook/engineering/workflow/#triage-broken-master page has broken formatting:

Screenshot_2022-12-28_at_10.07.51

It's surprising, given the source markdown is rendered correctly when checked in GitLab: https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/sites/handbook/source/handbook/engineering/workflow/index.html.md.

This MR attempts to make the formatting correct on https://about.gitlab.com/.

Does it work?

See the docs review app: https://ddieulivol-fix-docs-formatting.about.gitlab-review.app/handbook/engineering/workflow/index.html

Author Checklist

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added.
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR
    • If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.

Edited by David Dieulivol

Merge request reports