Skip to content

Simplify Badges-Offerings rule

Marcel Amirault requested to merge docs-simplify-vale-2 into master

What does this MR do?

While discussing some Vale quirks in slack, we made some realizations:

  • We often use \n or \n\n to look for the start of a line instead of ^, but learned from https://github.com/errata-ai/vale/issues/646#issuecomment-1596302642 that this is due to not understanding the different between raw and tokens for the regex. Changing to tokens lets us find the start of the line with ^, which significantly improves the output in editors. In those rules, the editor now underlines the actual issue, rather than the line above. For example, for incorrect note blocks:

    Before After
    Screenshot_2024-07-29_at_12.17.45 Screenshot_2024-07-29_at_12.17.30
  • We also used some regex that was quite inefficient. With more experience, I was able to clean up rules for faster execution. For example

    • Before (4233 steps): Screenshot_2024-07-29_at_15.13.19
      After (1592 steps): Screenshot_2024-07-29_at_15.13.08
    • Before (3158 steps): Screenshot_2024-07-29_at_15.19.22
      After (669 steps): Screenshot_2024-07-29_at_15.19.15
    • Before (789 steps): Screenshot_2024-07-29_at_15.42.17
      After (20 steps): Screenshot_2024-07-29_at_15.42.22
  • Some rules were unnecessarily complex, and we could just simplify to make them easier to read.

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 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 Marcel Amirault

Merge request reports

Loading