Skip to content

Remove docs warning re bad footnote chars

Chris Burgess requested to merge xurizaemon/gitlab:24423-docs-update-remove-footnote-warning into master

What does this MR do and why?

Remove documentation guidance to avoid using the character "w" in a markdown footnote reference. The related upstream bug is now fixed and this guidance is no longer relevant as of a recent release (exact version TBC).

Screenshots or screen recordings

This is a docs followup after an upstream bug in markdown rendering was fixed. Happy to assist if asked, but I think screenshots/recordings aren't likely to be useful here.

How to set up and validate locally

  • Related to #24423 (closed)
  • Confirm that the fix is merged in current Gitlab
  • Consider whether the docs could still be useful

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

This MR is a Documentation change. The docs fix relates to an MR which doesn't look like it included a CHANGELOG modification - I don't see CHANGELOG.md in !70612 (diffs) and I don't see the word "footnote" at https://gitlab.com/gitlab-org/gitlab/-/blob/45da3d6db7679226b2faf030e2398feb8246a0b1/CHANGELOG.md

I considered whether it was correct to remove the sentence "Reference tags can use letters and other characters.". I didn't feel that this sentence added meaningfully to the documentation on page once the remainder of the paragraph was removed. Input welcome!

Related to #24423 (closed)

Edited by Amy Qualls

Merge request reports