diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2018-12-31 20:35:24 +0000 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2018-12-31 20:35:24 +0000 |
| commit | a4e7b7704e53612b1fa159d6fe7e4c80a8269c43 (patch) | |
| tree | 17f37bdfccff27a848f4f661e496c1f8ca39e62a | |
| parent | 35e5833df4de26fc8e1b2c1d629dc27f239c956d (diff) | |
| download | gitlab-ce-a4e7b7704e53612b1fa159d6fe7e4c80a8269c43.tar.gz | |
Add to the 'how to update' section
| -rw-r--r-- | doc/development/documentation/improvement-workflow.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/development/documentation/improvement-workflow.md b/doc/development/documentation/improvement-workflow.md index 6efd9450c29..ef6392c6f7f 100644 --- a/doc/development/documentation/improvement-workflow.md +++ b/doc/development/documentation/improvement-workflow.md @@ -20,8 +20,13 @@ to achieve or improve their DevOps workflows. ## How to update the docs -- Follow the described standards and processes listed on the [GitLab Documentation guidelines](index.md) page. +- Follow the described standards and processes listed on the [GitLab Documentation guidelines](index.md) page, +including linked resources: the [Structure and template](structure.md) page, [Style Guide](styleguide.md), and [Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/). - Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). +- If you need any help to choose the correct place for a doc, discuss a documentation +idea or outline, or request any other help, ping the Technical Writer for the relevant +[DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages) +in your issue or MR, or write within `#docs` if you are a member of GitLab's Slack workspace. ## Merging |