Commit f82f3e2b authored by Mike Lewis's avatar Mike Lewis

Add standard on merging

parent 295a0219
...@@ -274,7 +274,7 @@ tests. If it doesn't, the whole test suite will run (including docs). ...@@ -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 Before getting started, make sure you read the introductory section
"[contributing to docs](#contributing-to-docs)" above and the "[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. 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) - 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. ...@@ -282,6 +282,15 @@ for GitLab Team members.
- Label the MR `Documentation` - Label the MR `Documentation`
- Assign the correct milestone (see note below) - 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:** NOTE: **Note:**
If the release version you want to add the documentation to has already been 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 frozen or released, use the label `Pick into X.Y` to get it merged into
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment