Scrub instances of "you can" from style guide
What does this MR do?
As part of reviewing a MR for Zach, I noticed several instances of you can in the page he was working on. I went looking for the instructions for NOT to use that phrasing, because I wanted to include it in my review. It took me a moment to remember that the info was in the word list, and not on the main style guide page.
Then I started noticing instances of you can on the style guide page, and wondered how many there were. Answer: quite a few! We're subtly reinforcing the use of the you can phrasing by using it repeatedly in our style guide. This MR doesn't clean out 100% of the usage, but it tackles the majority of them.
extends: existence
message: "Avoid 'you can' - be concise."
link: https://docs.gitlab.com/development/documentation/styleguide/word_list/#you-can
level: warning
ignorecase: true
tokens:
- "you can"
Related issues
Related to Adds 'you can' to Wordy.yml (!187383 - merged)
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.