diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2018-12-31 22:43:21 +0300 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2018-12-31 22:43:21 +0300 |
| commit | cb6e991cefeea9d5ce970355c491106f47f775d8 (patch) | |
| tree | 33a73e59a0be3001e27738eee779d930c96fb7c4 /doc | |
| parent | 66d4197edd60ae0b012e3c7003bdf8200bfdd36b (diff) | |
Add index.md link and other clarifications
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/documentation/improvement-workflow.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/development/documentation/improvement-workflow.md b/doc/development/documentation/improvement-workflow.md index a54915d813e..6efd9450c29 100644 --- a/doc/development/documentation/improvement-workflow.md +++ b/doc/development/documentation/improvement-workflow.md @@ -20,7 +20,8 @@ to achieve or improve their DevOps workflows. ## How to update the docs -Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). +- Follow the described standards and processes listed on the [GitLab Documentation guidelines](index.md) page. +- Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). ## Merging @@ -32,10 +33,10 @@ that it meets the [Documentation Guidelines](index.md) and [Style Guide](stylegu If the author or reviewer has any questions, or would like a techncial writer's review before merging, mention the writer who is assigned to the relevant [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages). -## Technical Writer Review +## Technical Writer review -The technical writing team reviews changes after they are merged, unless one of -the technical writers already reviewed prior to the merge. +The technical writing team reviews changes after they are merged, unless a prior +review is requested. ## Other ways to help |