gitlab-org--gitlab-foss/.gitlab/merge_request_templates/Documentation.md

42 lines
2.6 KiB
Markdown
Raw Normal View History

2019-01-11 04:04:02 +00:00
<!-- Follow the documentation workflow https://docs.gitlab.com/ee/development/documentation/workflow.html -->
<!-- Additional information is located at https://docs.gitlab.com/ee/development/documentation/ -->
2018-08-16 09:30:04 +00:00
<!-- Mention "documentation" or "docs" in the MR title -->
2019-01-11 04:04:02 +00:00
<!-- For changing documentation location use the "Change documentation location" template -->
## What does this MR do?
2019-01-11 04:04:02 +00:00
<!-- Briefly describe what this MR is about. -->
## Related issues
<!-- Link related issues below. Insert the issue link or reference after the word "Closes" if merging this should automatically close it. -->
2018-08-16 09:30:04 +00:00
## Author's checklist
2019-01-17 19:37:24 +00:00
- [ ] Follow the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
2019-01-17 20:58:27 +00:00
- [ ] Link docs to and from the higher-level index page, plus other related docs where helpful.
2019-01-17 19:37:24 +00:00
- [ ] Apply the ~Documentation label and intended milestone.
2019-01-11 04:04:02 +00:00
- [ ] [Port the MR to EE (or backport from CE)](https://docs.gitlab.com/ee/development/documentation/index.html#cherry-picking-from-ce-to-ee): _always recommended, required when the `ee-compat-check` job fails_.
2018-08-16 09:30:04 +00:00
## Review checklist
2019-01-17 19:37:24 +00:00
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).
**1. Primary Reviewer**
2019-01-17 20:58:27 +00:00
* [ ] 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.
2019-01-17 19:37:24 +00:00
**2. Technical Writer**
* [ ] Optional: 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/categories/#devops-stages).
**3. Maintainer**
1. [ ] Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
2019-01-23 05:55:36 +00:00
1. [ ] Ensure a release milestone of the format XX.Y is set. If the freeze for that release has begun, add the label `pick into <XX.Y>` unless this change is not required for the release. In that case, simply change the milestone.
1. [ ] If EE and CE MRs exist, merge the EE MR first, then the CE MR.
1. [ ] After merging, if there has not been a technical writer review, [create an issue for one using the Doc Review template](https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issuable_template=Doc%20Review).
/label ~Documentation