Skip to content

Remove broken br tags

Marcel Amirault requested to merge docs-fix-line-breaks into master

What does this MR do?

This removes <br> tags that broke the rendering of of the lists in the related pages. See:

kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/user/project/clusters/add_remove_clusters.md name=default>
   Found invalidly used HTML closing tag for 'br' on line 161
   Found invalidly used HTML closing tag for 'br' on line 292

Screen_Shot_2020-06-11_at_17.20.22

I suspect that the <br> tags were added because the list was rendering like this without them:

Screen_Shot_2020-06-11_at_17.36.18

But all it needed was to have the extra blank lines removed completely, which fixed the rendering:

Screen_Shot_2020-06-11_at_17.31.57

The spacing is a bit tight, but that can be discussed separately, and I see there is already: #221134 (moved)

Related issues

Related to !30555 (merged)

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

  • Optional: 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.

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.

Merge request reports