Skip to content

Update recommended table formatter

Marcel Amirault requested to merge docs-update-table-formatter into master

What does this MR do?

While reviewing !128876 (merged), I saw had some funky formatting and notes to try to avoid automatically adding whitespace.

I decided to make use of the newly released version of the VS Code Markdown Formatter. There is a brand new feature that the maintainer added (at my request, with my proposed UI text too 😅) that I wanted to test and see if it would handle the whitespace, and it did a great job cleaning everything up!

I think this tool is so good, we should make it the standard and strongly recommend it, so I'm adding it to the style guide.

I've also run it on a selection of random tables in the CI docs to see if it helps there, and it does seem to work extremely well! 🎉

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Marcel Amirault

Merge request reports