Skip to content

Draft: Update HAML help page links to use .md extension

Marcel Amirault requested to merge update-help-links-1 into master

What does this MR do and why?

Links to help are hard to find and maintain due to the lack of the .md extension in the links from HAML files. Related to the discussions in the related issue, we decided to recommend (and enforce when possible) the use of the file extension. The code is easier to read, and when a TW moves or renames a file, a simple search for the path/name will find it in the code, making it easier to maintain.

This is already the documented recommendation: https://docs.gitlab.com/ee/development/documentation/help.html#linking-to-help

This MR updates the HAML lint that checks help_page_path() and help_page_url() links to enforce .md extensions, and updates all HAML files (with automated find and replace) to use .md in the filename. This is already a huge MR, so addressing other frontend files or ruby files will need to be done in followups.

The documentation link check passes in the pipeline: https://gitlab.com/gitlab-org/gitlab/-/jobs/7672371559

Related to #419673 (closed)

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Edited by Marcel Amirault

Merge request reports

Loading