Skip to content

Add style guide and vale rule for no links in headings

Cynthia "Arty" Ng requested to merge docs-vale-links-in-headings into master

What does this MR do?

Adds a style guide note and relevant vale rule to disallow links in headings.

Links in headings disrupts the default behaviour, because the heading should link to itself, but instead will link people to whatever is specified.

Related issues

The issue came up for the handbook: gitlab-com/content-sites/handbook#124 (closed)

The 25 findings from this rule were cleaned up in Cleans up subheadings with embedded links (!161088 - merged) earlier today.

Since I wrote a custom vale rule, I figure I should contribute it to our docs 😀

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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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 Amy Qualls

Merge request reports

Loading