Add variants of 'check out' to word list
What does this MR do?
Adds a (very rough) stub to differentiate between checkout
(a Git command) and "check out" (a phrasal verb). @pedroms and I discovered an instance of "checkout" (not wrapped in code tags) in the UI, and we realized we had no guidance.
- Microsoft: OK to use as a verb phrase, as in check in code or check in changes. Don't use as a noun. (https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/check-in)
- Google: no guidance
I bashed out just enough of a MVC to make clear what was needed; I fully expect @sselhorn will polish it. She may want to add checkin
vs check in
while we're at it, though I'm not as concerned about it. It doesn't collide with a Git term.
Related issues
Related to #346053 (closed) where we're working on UI message changes for %14.6.
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are only adding documentation, do not add any of the following labels:
~"type::feature"
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Review 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 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. - 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 above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.