Skip to content

Update markdown table examples

Marcel Amirault requested to merge docs-markdown-tables into master

What does this MR do?

Related to !42086 (merged)

The linked MR added some HTML code to tables that don't render properly on the docs site: https://docs.gitlab.com/ee/user/markdown.html#tables. It was also causing large Kramdown warnings: https://gitlab.com/gitlab-org/gitlab-docs/-/jobs/784711268#L523

The HTML is actually valid in GitLab, and can be used in issues, MRs, and in the internal markdown viewer, so we should explain this.

I've updated the tables examples to:

  • Remove the task lists examples that weren't working.
  • Move the examples to a "standalone" example, that doesn't have a rendered equivalent that would break on docs.gitlab.com.
  • Added one example of embedding HTML in a table that should actually work properly.
  • Removed the right justification from the last column in the first table example, as that was also making it render poorly. Justification is already explained in the next example.

Related issues

Close #257807 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcin Sedlak-Jakubowski

Merge request reports

Loading