diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2019-02-18 21:10:26 +0000 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2019-02-18 21:10:26 +0000 |
| commit | f0c1bae7dbb6e232f4699b91b98444686dc81db8 (patch) | |
| tree | b021c0b1211f39fd159edc6d5318207a2d31c7b4 /doc/development/documentation | |
| parent | a2449492d0fd3f41abb86204ebbcd221b4aa994a (diff) | |
| download | gitlab-ce-f0c1bae7dbb6e232f4699b91b98444686dc81db8.tar.gz | |
Update improvement-workflow re who creates and confirms tech writer review issues
Diffstat (limited to 'doc/development/documentation')
| -rw-r--r-- | doc/development/documentation/improvement-workflow.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/development/documentation/improvement-workflow.md b/doc/development/documentation/improvement-workflow.md index 2fd295fba4b..fbc3cf806ee 100644 --- a/doc/development/documentation/improvement-workflow.md +++ b/doc/development/documentation/improvement-workflow.md @@ -47,13 +47,14 @@ The process can involve the following parties/phases, and is replicated in the ` **1. Primary Reviewer** - Review by a [code reviewer](https://about.gitlab.com/handbook/engineering/projects/) or other appropriate colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes. **2. Technical Writer** - Optional - If not requested for this MR, must be scheduled post-merge. To request a pre-merge review, assign the writer listed for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages). +To request a post-merge review, [create an issue for one using the Doc Review template](https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issuable_template=Doc%20Review) and link it from the MR that makes the doc change. **3. Maintainer** 1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer 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 <XX.Y>` 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 using the Doc Review template](https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issuable_template=Doc%20Review). +4. After merging, if there has not been a technical writer review and an issue for a follow-up review was not already created and linked from the MR, [create the issue using the Doc Review template](https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issuable_template=Doc%20Review) and link it from the MR. ## Other ways to help |