Skip to content

Remove no-markdown-emoji test

Amy Qualls requested to merge aqualls-markdown-emoji-test into master

What this merge request does now

Removes the MarkdownEmoji.yml test. The benefit is not huge, and we'd have to solve another regex. Our time is better spent fixing one of the tests that returns more hits.

Original plan

MarkdownEmoji.yml is one of the five tests affected by Vale v2.26.0 changing how inline scopes are handled.

This rule should be the easiest to fix. It's already a regex that declares a scope of raw (which is what the affected rules are supposed to start using) and an oddly-broad scope of text, which just means … "everything". Let's remove the scope: text line, and check to see if this test works properly again.

When I ran this test locally while setting level: error (instead of warning) I got the following results, which tell me the test does still work:

architecture/blueprints/organization/index.md
 239:32  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 239:53  error  Replace ':x:' with GitLab SVGs or Unicode emoji.                 gitlab.Markdown_emoji
 240:32  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 240:53  error  Replace ':x:' with GitLab SVGs or Unicode emoji.                 gitlab.Markdown_emoji
 241:25  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 241:46  error  Replace ':x:' with GitLab SVGs or Unicode emoji.                 gitlab.Markdown_emoji
 242:18  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 242:39  error  Replace ':x:' with GitLab SVGs or Unicode emoji.                 gitlab.Markdown_emoji
 243:34  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 243:55  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 244:26  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 245:28  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 246:25  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 247:65  error  Replace ':white_check_mark:' with GitLab SVGs or Unicode emoji.  gitlab.Markdown_emoji
 247:86  error  Replace ':x:' with GitLab SVGs or Unicode emoji.                 gitlab.Markdown_emoji

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

Merge request reports

Loading