Test for logged(-)in / signed(-)in user string, fix results
What does this MR do?
Adds lines to SubstitutionWarning.yml
to test for these strings. Decision was made in !106189 (comment 1234591741) by @sselhorn.
logged in user: "authenticated user"
logged-in user: "authenticated user"
signed in user: "authenticated user"
signed-in user: "authenticated user"
Cleans up most, but not all, of the results when I grepped. Some API definitions should be updated, but that's an exercise for another time.
Related issues
- Related to Draft: verb "to log in", adjective "log‑in", su... (!106189) where discussion about the naming happened
- Related to Fix "Login" as a verb - replace with "Register"... (#384504) as the parent issue for that merge request
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
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.