Declare preference for "cherry-pick" and test it
What does this MR do?
Yesterday in Slack, Hiru brought up an inconsistency she spotted in the nav: cherry pick in one place, and cherry-pick in another. I checked the Git documentation for git cherry-pick, and they prefer cherry-pick in natural language: https://git-scm.com/docs/git-cherry-pick
This MR should wrap up the problem, by adding an entry to the word list, and adding it to a substitution test. The full slate of MRs done so far:
- Fix the nav: gitlab-docs!5339 (merged)
- Fix in-page usage: !179858 (merged)
- (this MR) Add word-list guidance and a test
(@brendan777, thanks for the tag-team! Hiru found that problem in the last few minutes of my day, and I knew if I didn't tag you in the Slack thread right then, I ran the risk of forgetting to fix this.)
Related issues
Related to Inconsistent use of 'cherry-pick' versus 'cherr... (gitlab-docs#1849 - closed)
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.