From b2c6058a499d707cec84e6da552dfa6ee1b3bbd4 Mon Sep 17 00:00:00 2001 From: Mike Lewis Date: Thu, 17 Jan 2019 20:58:27 +0000 Subject: Update Documentation template --- .gitlab/merge_request_templates/Documentation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to '.gitlab/merge_request_templates') diff --git a/.gitlab/merge_request_templates/Documentation.md b/.gitlab/merge_request_templates/Documentation.md index 9071146b366..1cdb1e636f0 100644 --- a/.gitlab/merge_request_templates/Documentation.md +++ b/.gitlab/merge_request_templates/Documentation.md @@ -17,7 +17,7 @@ Closes ## Author's checklist - [ ] 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, as appropriate. +- [ ] Link docs to and from the higher-level index page, plus other related docs where helpful. - [ ] Apply the ~Documentation label and intended milestone. - [ ] [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_. @@ -27,7 +27,7 @@ All reviewers can help ensure accuracy, clarity, completeness, and adherence to **1. Primary Reviewer** -* [ ] Review by a code reviewer or other selected expert to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes. +* [ ] 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** @@ -38,6 +38,6 @@ All reviewers can help ensure accuracy, clarity, completeness, and adherence to 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. 2. [ ] Ensure a release milestone of the format XX.Y is set. If the freeze for that release has begun, add the label `pick into ` unless this change is not required for the release. In that case, simply change the milestone. 3. [ ] If EE and CE MRs exist, merge the EE MR first, then the CE MR. -4. [ ] After merging, if there has not been a technical writer review, create an issue for one with labels ~docs-review and ~Documentation, a link to this MR, and assign it to the technical writer for the [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages). +4. [ ] 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?issue[title]=Validate%20new%20concept&issuable_template=Research%20proposal). /label ~Documentation -- cgit v1.2.3