Draft: Add capitalization rule to vale
What does this MR do?
After and internal discussion, we realized we were using markdownlint (a Markdown formatting linter) to lint for language issues, which we normally reserve for Vale (a language linter).
This MR:
- Removes the
MD044
rule from the markdownlint configuration, greatly simplifying the file. I don't think we were maintaining the list very actively anyways. - Adds the capitalization entries to a new Vale vocabulary: https://vale.sh/docs/topics/vocab/
- Removes the markdownlint lint exceptions for
MD044
, and replaces them with an equivalent Vale exception.- Note that the Vale exception was not needed in many places, Vale was happy to ignore things that were false positives for markdownlint.
Related issues
- Related to Convert the GitLab Vale styles directory `gitla... (technical-writing#1209)
- Related to https://gitlab.com/gitlab-org/gitlab/-/issues/47389+
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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