debian-mirror-gitlab/.gitlab/merge_request_templates/Documentation.md

40 lines
2.2 KiB
Markdown
Raw Normal View History

2019-07-07 11:18:12 +05:30
<!-- 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/ -->
2019-05-05 18:10:48 +05:30
<!-- Mention "documentation" or "docs" in the MR title -->
2019-07-07 11:18:12 +05:30
<!-- For changing documentation location use the "Change documentation location" template -->
2019-05-05 18:10:48 +05:30
## What does this MR do?
2019-07-07 11:18:12 +05:30
<!-- Briefly describe what this MR is about. -->
2019-05-05 18:10:48 +05:30
## Related issues
2019-07-07 11:18:12 +05:30
<!-- Link related issues below. Insert the issue link or reference after the word "Closes" if merging this should automatically close it. -->
2019-05-05 18:10:48 +05:30
## Author's checklist
2019-07-07 11:18:12 +05:30
- [ ] Follow the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
- [ ] Link docs to and from the higher-level index page, plus other related docs where helpful.
- [ ] Apply the ~Documentation label.
2019-05-05 18:10:48 +05:30
## Review checklist
2019-07-07 11:18:12 +05:30
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**
* [ ] 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.
**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.
1. [ ] Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
1. [ ] 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).
2019-05-05 18:10:48 +05:30
/label ~Documentation