diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2018-12-24 18:46:45 +0000 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2018-12-24 13:53:35 -0500 |
| commit | f82f3e2bc602e151b2819ab7744740eb1e46d562 (patch) | |
| tree | 4e9465a72b2aaefbf782235670ad2c83263db8a9 /doc/development | |
| parent | 295a02193ec57ececac3dcfc4032b758d346f3fe (diff) | |
| download | gitlab-ce-f82f3e2bc602e151b2819ab7744740eb1e46d562.tar.gz | |
Add standard on merging
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/documentation/index.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index c4bd2b7cc5b..46f9c1847a3 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -274,7 +274,7 @@ tests. If it doesn't, the whole test suite will run (including docs). Before getting started, make sure you read the introductory section "[contributing to docs](#contributing-to-docs)" above and the -[tech writing workflow](https://about.gitlab.com/handbook/product/technical-writing/workflow/) +[tech writing workflow](workflow.md) for GitLab Team members. - Use the current [merge request description template](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/.gitlab/merge_request_templates/Documentation.md) @@ -282,6 +282,15 @@ for GitLab Team members. - Label the MR `Documentation` - Assign the correct milestone (see note below) +Documentation will be merged if it meets our style standards, is clear, and is known to be +correct by the person merging the MR or the SME (such as a developer) who contributed it. +Further needs for ‘what would make this doc even better’ should be immediately addressed in a +follow-up MR or issue. + +The individual who merges the documentation must have also reviewed the documentation +for the above standard. Typically this is a technical writer, but others, such as Support Managers, +can freely merge smaller changes. See the [Documentation Workflows](workflow.md). + NOTE: **Note:** If the release version you want to add the documentation to has already been frozen or released, use the label `Pick into X.Y` to get it merged into |
