Skip to content

Add new vale rule for GLFM

Marcel Amirault requested to merge docs-split-out-glfm-vale into master

What does this MR do?

After reviewing a few developer doc MRs about GLFM (ex: !107772 (merged)), I felt the usage was clear and we didn't need to explicitly spell out GitLab Flavored Markdown every time in these docs (or raise diff warnings about them). It's still important to be sure the regular product documentation is clear though, so I don't want to remove the rule completely.

This MR splits the vale rule for GLFM and GFM into it's own rule, which can then be excluded from development docs where the usage is clear (they introduce the terminology in the page with GitLab Flavored Markdown (GLFM) and GitHub Flavored Markdown (GFM)).

Before these changes, we have 127 warnings for GFFM and GFM across all docs. After we split this out and exclude it from these two development docs, there are only 11 warnings total, so we're removing 116 warnings.

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