You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .gitlab/merge_request_templates/Document.md
+25-25
Original file line number
Diff line number
Diff line change
@@ -19,51 +19,51 @@ Link related issues below. Insert the issue link or reference after the word "Cl
19
19
20
20
## Author's checklist (required)
21
21
22
-
-[ ] Follow the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
23
-
- If you have **Developer** permissions or higher:
24
-
-[ ] Ensure that the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges) is added to doc's `h1`.
25
-
-[ ] Apply the ~documentation label, plus:
26
-
- The corresponding DevOps stage and group labels, if applicable.
27
-
-~"development guidelines" when changing docs under `doc/development/*`, `CONTRIBUTING.md`, or `README.md`.
28
-
-~"development guidelines" and ~"Documentation guidelines" when changing docs under `development/documentation/*`.
29
-
-~"development guidelines" and ~"Description templates (.gitlab/\*)" when creating/updating issue and MR description templates.
30
-
-[ ] Assign the [designated Technical Writer](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments).
22
+
-[ ] Follow the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
23
+
-If you have **Developer** permissions or higher:
24
+
-[ ] Ensure that the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges) is added to doc's `h1`.
25
+
-[ ] Apply the ~documentation label, plus:
26
+
- The corresponding DevOps stage and group labels, if applicable.
27
+
-~"development guidelines" when changing docs under `doc/development/*`, `CONTRIBUTING.md`, or `README.md`.
28
+
-~"development guidelines" and ~"Documentation guidelines" when changing docs under `development/documentation/*`.
29
+
-~"development guidelines" and ~"Description templates (.gitlab/\*)" when creating/updating issue and MR description templates.
30
+
-[ ] Assign the [designated Technical Writer](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments).
31
31
32
32
Do not add the ~"feature", ~"frontend", ~"backend", ~"bug", or ~"database" labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.
33
33
34
34
When applicable:
35
35
36
-
-[ ] Update the [permissions table](https://docs.gitlab.com/ee/user/permissions.html).
37
-
-[ ] Link docs to and from the higher-level index page, plus other related docs where helpful.
38
-
-[ ] Add the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges) accordingly.
39
-
-[ ] Add [GitLab's version history note(s)](https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text).
40
-
-[ ] Add/update the [feature flag section](https://docs.gitlab.com/ee/development/documentation/feature_flags.html).
36
+
-[ ] Update the [permissions table](https://docs.gitlab.com/ee/user/permissions.html).
37
+
-[ ] Link docs to and from the higher-level index page, plus other related docs where helpful.
38
+
-[ ] Add the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges) accordingly.
39
+
-[ ] Add [GitLab's version history note(s)](https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text).
40
+
-[ ] Add/update the [feature flag section](https://docs.gitlab.com/ee/development/documentation/feature_flags.html).
41
41
42
42
## Review checklist
43
43
44
44
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
45
45
46
-
**1. Primary Reviewer**
46
+
1.**Primary Reviewer**
47
47
48
-
*[ ] Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
48
+
-[ ] Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
49
49
50
50
**2. Technical Writer**
51
51
52
-
-[ ] Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/product-categories/#devops-stages).
53
-
-[ ] Ensure docs metadata are present and up-to-date.
54
-
-[ ] Ensure ~"Technical Writing" and ~"documentation" are added.
55
-
-[ ] Add the corresponding `docs::`[scoped label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=docs%3A%3A).
56
-
-[ ] If working on UI text, add the corresponding `UI Text`[scoped label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=ui+text).
57
-
-[ ] Add ~"tw::doing" when starting work on the MR.
58
-
-[ ] Add ~"tw::finished" if Technical Writing team work on the MR is complete but it remains open.
52
+
-[ ] Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/product-categories/#devops-stages).
53
+
-[ ] Ensure docs metadata are present and up-to-date.
54
+
-[ ] Ensure ~"Technical Writing" and ~"documentation" are added.
55
+
-[ ] Add the corresponding `docs::`[scoped label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=docs%3A%3A).
56
+
-[ ] If working on UI text, add the corresponding `UI Text`[scoped label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=ui+text).
57
+
-[ ] Add ~"tw::doing" when starting work on the MR.
58
+
-[ ] Add ~"tw::finished" if Technical Writing team work on the MR is complete but it remains open.
59
59
60
60
For more information about labels, see [Technical Writing workflows - Labels](https://about.gitlab.com/handbook/engineering/ux/technical-writing/workflow/#labels).
61
61
62
62
For suggestions that you are confident don't need to be reviewed, change them locally
63
63
and push a commit directly to save others from unneeded reviews. For example:
64
64
65
-
- Clear typos, like `this is a typpo`.
66
-
- Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.
65
+
-Clear typos, like `this is a typpo`.
66
+
-Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.
67
67
68
68
For more information, see our documentation on [Merging a merge request](https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request).
0 commit comments