Rules in gitlab_base: convert comments to description field
What does this MR do?
It …
- edits all rules in
doc/.vale/gitlab_baseto move descriptions from comments to thedescription:key. - redacts the rest of the comment, including where we specified the full name (that's not needed) and a link out to Vale's styles (we needed this more 3 years ago, but not now)
- I'll do the rules in
gitlab_docsin a separate MR, just to keep the size down.
Does the first half of addressing @marcel.amirault's comment in #docs-tooling:
Marcel: @aqualls, @eread - While looking at Vale filters, I noticed that
.Nameand.Descriptionare available, and realized that this relates to the ability to addname:anddescription:entries into the YAML of the rules. So I wonder if that could mean that we could move the code comments into the code?
He pointed out that this:
Previous version
# Warning: gitlab_base.DefaultBranch
#
# Do not refer to the default branch as the 'master' branch, if possible.
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence
message: "Use 'default branch' or `main` instead of `master`, when possible."
vocab: false
level: warning
ignorecase: true
link: https://docs.gitlab.com/development/documentation/styleguide/word_list/#branch
scope: raw
raw:
- '\`master\`'
Could become this:
name: gitlab_base.DefaultBranch
Description: |
Do not refer to the default branch as the 'master' branch, if possible.
For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence
message: "Use 'default branch' or `main` instead of `master`, when possible."
vocab: false
level: warning
ignorecase: true
link: https://docs.gitlab.com/development/documentation/styleguide/word_list/#branch
scope: raw
raw:
- '\`master\`'
He then noted that Vale gets the name of the rule from the filename, so we don't need the name: parameter.
Related issues
Related to Rules in gitlab_docs: convert comments to descr... (!187752 - merged), which does the same thing for the rules in gitlab_docs.
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.