Skip to content

Fix anchors, including those created by headings with Chinese characters

Marcel Amirault requested to merge (removed):docs-anchors2 into master

What does this MR do?

First, this fixes a broken anchor in the SSL settings doc.

Secondly, the SMTP settings doc contains a few headings with Chinese characters, which get converted to some funny anchors that the anchor test struggles with:

<a href="#example-configurations" id="markdown-toc-example-configurations">Example configurations</a>    <ul>
      <li><a href="#qq-exmail-%E8%85%BE%E8%AE%AF%E4%BC%81%E4%B8%9A%E9%82%AE%E7%AE%B1" id="markdown-toc-qq-exmail-腾讯企业邮箱">QQ exmail (腾讯企业邮箱)</a></li>
      <li><a href="#aliyun-direct-mail%E9%98%BF%E9%87%8C%E4%BA%91%E9%82%AE%E4%BB%B6%E6%8E%A8%E9%80%81" id="markdown-toc-aliyun-direct-mail阿里云邮件推送">Aliyun Direct Mail(阿里云邮件推送)</a></li>
      <li><a href="#aliyun-enterprise-mail-with-tls-%E9%98%BF%E9%87%8C%E4%BC%81%E4%B8%9A%E9%82%AE%E7%AE%B1" id="markdown-toc-aliyun-enterprise-mail-with-tls-阿里企业邮箱">Aliyun Enterprise Mail with TLS (阿里企业邮箱)</a></li>

(each error actually present twice, due to being present twice in the html)

[ ERROR ] internal_anchors - Broken anchor detected!
  - anchor `#qq-exmail-%e8%85%be%e8%ae%af%e4%bc%81%e4%b8%9a%e9%82%ae%e7%ae%b1`
  - link `#qq-exmail-%E8%85%BE%E8%AE%AF%E4%BC%81%E4%B8%9A%E9%82%AE%E7%AE%B1`
  - source file `/builds/Ravlen-Repos/gitlab-docs/public/omnibus/settings/smtp.html`
  - destination `/builds/Ravlen-Repos/gitlab-docs/public/omnibus/settings/smtp.html`
[ ERROR ] internal_anchors - Broken anchor detected!
  - anchor `#aliyun-direct-mail%e9%98%bf%e9%87%8c%e4%ba%91%e9%82%ae%e4%bb%b6%e6%8e%a8%e9%80%81`
  - link `#aliyun-direct-mail%E9%98%BF%E9%87%8C%E4%BA%91%E9%82%AE%E4%BB%B6%E6%8E%A8%E9%80%81`
  - source file `/builds/Ravlen-Repos/gitlab-docs/public/omnibus/settings/smtp.html`
  - destination `/builds/Ravlen-Repos/gitlab-docs/public/omnibus/settings/smtp.html`
[ ERROR ] internal_anchors - Broken anchor detected!
  - anchor `#aliyun-enterprise-mail-with-tls-%e9%98%bf%e9%87%8c%e4%bc%81%e4%b8%9a%e9%82%ae%e7%ae%b1`
  - link `#aliyun-enterprise-mail-with-tls-%E9%98%BF%E9%87%8C%E4%BC%81%E4%B8%9A%E9%82%AE%E7%AE%B1`
  - source file `/builds/Ravlen-Repos/gitlab-docs/public/omnibus/settings/smtp.html`
  - destination `/builds/Ravlen-Repos/gitlab-docs/public/omnibus/settings/smtp.html`

The solution is to take the Chinese out of the heading, and put it below as regular text. I checked and these headers are not linked to anywhere else in the docs.

Changing the header title?

  • Is it completely necessary to change the title? Changing titles breaks deep linking. If yes, proceed further.
  • Move the old heading title to the bottom of the page.
  • Change the header tag to h5, #####.

Moving docs to a new location?

See the guidelines: https://docs.gitlab.com/ee/development/documentation/#changing-document-location.

  • Make sure the old link is not removed and has its contents replaced with a link to the new location.
  • Make sure internal links pointing to the document in question are not broken.
Edited by Marcel Amirault

Merge request reports