Skip to content

Fix various issues in markdown tables

What does this MR do?

Split out from !206473 (closed) which became too big.

While reviewing translations of the docs, we found some tables with rendering issues, due to pipe (|) characters not being escaped. First brought to my attention here: https://gitlab.com/gitlab-com/localization/tech-docs-forked-projects/prod/gitlab/-/merge_requests/297#note_2780298890

I think we should add a Vale lint rule to prevent this, as it completely breaks the rendering of the row in the table.

As part of searching for tables with this issue, I found several that should be auto aligned. Cleaning this up now makes it possible to implement the Vale rule, as these tables were false positives on my first attempt at creating and testing a rule locally. The Vale rule relies on "table" pipes having spaces, dashes, colons, or newlines around them: - \n:. For example:

| Pattern          | Description |
|:-----------------| ----------- |
| `.*`             | The pipes in the header row have dashes, colons, spaces, or newlines around them. |
| `.*`             | The pipes left and right of this cell have spaces or newlines around them. |
| `stable|release` | The `|` in the regex to the left breaks this table. It is not surrounded by any of the mentioned characters, and is not escaped. |
| `stable\|release` | The `\|` in the regex to the left fixes this row. |

Rendered:

Pattern Description
.* The pipes in the header row have dashes, colons, spaces, or newlines.
.* The pipes left and right of this cell have spaces or newlines.
`stable release`
stable|release The | in the regex to the left fixes this row.

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

Loading