Skip to content

Add new rule to prevent multi-line links

Marcel Amirault requested to merge docs-multiline-links into master

What does this MR do?

As part of looking into !93529 (merged), I found that multi-line links can be problematic as they are ignored by some of our link tests. We could update every single link test, but then they would be far more complex and hard to maintain. Instead we should just mandate that links all be on the same line.

This also adds an entry to the style guide to point this out.

To start, I'm setting the rule to the warning level because there are too many multi-line links in the docs to fix right now. While some are likely broken in some way (like the handful fixed in this MR to demonstrate the rule), most are still technically correct and don't need to be immediately fixed. See this job log for full results: https://gitlab.com/gitlab-org/gitlab/-/jobs/2787576387

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Marcel Amirault

Merge request reports

Loading