Fix typo in templates doc
What does this MR do?
Introduced via !87479 (comment 956473081)
Related issues
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 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.
Merge request reports
Activity
added docsimprovement documentation typemaintenance labels
assigned to @bbodenmiller
Hi @msedlakjakubowski! Please review this documentation merge request.
added twtriaged label
Thank you for your contribution to GitLab. We believe that everyone can contribute and contributions like yours are what make GitLab great!
- Our Merge Request Coaches will ensure your contribution is reviewed in a timely manner*.
- If you haven't, please set up a
DANGER_GITLAB_API_TOKEN
. - You can comment
@gitlab-bot label ~"group::<group name>"
to add a group label or@gitlab-bot label ~"type::<type name>"
to add a type label. - If you need help moving the MR forward or finding a reviewer, feel free to ask
@gitlab-bot help
or ping a Merge Request Coach. - Read more on how to get help.
- You can provide feedback on the GitLab Contributor Experience in this survey
This message was generated automatically. You're welcome to improve it.
added Community contribution label
removed Community contribution label
Suggested Reviewers (beta)
The individuals below may be good candidates to participate in the review based on various factors.
You can use slash commands in comments to quickly assign
/assign_reviewer @user1
.Suggested Reviewers @proglottis
,@stanhu
,@kmann
,@aakriti.gupta
,@vitallium
If you do not believe these suggestions are useful, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue:
https://gitlab.com/gitlab-org/gitlab/-/issues/357923
.Automatically generated by Suggested Reviewers Bot - an experimental ML-based recommendation engine created by ~"group::applied ml".
requested review from @msedlakjakubowski
1 Warning 0cd5d148: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines. 1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. If needed, you can retry the
danger-review
job that generated this comment.Documentation review
The following files require a review from a technical writer:
doc/user/project/description_templates.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
Generated by
DangerOops
Thanks for fixing @bbodenmiller!added Technical Writing docsfix labels and removed docsimprovement label
changed milestone to %15.1
enabled an automatic merge when the pipeline for 851a7e24 succeeds
@bbodenmiller, how was your code review experience with this merge request? Please tell us how we can continue to iterate and improve:
- Leave a
or a on this comment to describe your experience. - Create a new comment starting with
@gitlab-bot feedback
below, and leave any additional feedback you have for us in the comment.
Have five minutes? Take our survey to give us even more feedback on how GitLab can improve the contributor experience.
Thanks for your help!
- Leave a
mentioned in commit a2eafa31
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added Community contribution label
added releasedpublished label
added releasedcandidate label and removed releasedpublished label