Documentation workflow

Documentation at GitLab follows a workflow.

Before merging

Ensure your documentation includes:

Ensure you’ve followed the style guide and word list.

Branch naming

The CI/CD pipeline for the main GitLab project is configured to run shorter, faster pipelines on merge requests that contain only documentation changes.

If you submit documentation-only changes to Omnibus, Charts, or Operator, to make the shorter pipeline run, you must follow these guidelines when naming your branch:

Branch name Valid example
Starting with docs/ docs/update-api-issues
Starting with docs- docs-update-api-issues
Ending in -docs 123-update-api-issues-docs

Documentation labels

When you author an issue or merge request, choose the Documentation template. It includes these labels, which are added to the merge request:

A member of the Technical Writing team adds these labels:

With the exception of /doc/development/documentation, technical writers do not review content in the doc/development directory. Any Maintainer can merge content in the doc/development directory. If you would like a technical writer review of content in the doc/development directory, ask in the #docs Slack channel.

Post-merge reviews

If not assigned to a Technical Writer for review prior to merging, a review must be scheduled immediately after merge by the developer or maintainer. For this, create an issue using the Doc Review description template and link to it from the merged merge request that introduced the documentation change.

Circumstances in which a regular pre-merge Technical Writer review might be skipped include:

  • There is a short amount of time left before the milestone release. If fewer than three days are remaining, seek a post-merge review and ping the writer via Slack to ensure the review is completed as soon as possible.
  • The size of the change is small and you have a high degree of confidence that early users of the feature (for example, users) can easily use the documentation as written.


  • At GitLab, we treat documentation like code. As with code, documentation must be reviewed to ensure quality.
  • Documentation forms part of the GitLab definition of done.
  • That pre-merge Technical Writer reviews should be most common when the code is complete well in advance of a milestone release and for larger documentation changes.
  • You can request a post-merge Technical Writer review of documentation if it’s important to get the code with which it ships merged as soon as possible. In this case, the author of the original MR can address the feedback provided by the Technical Writer in a follow-up MR.
  • The Technical Writer can also help decide that documentation can be merged without Technical writer review, with the review to occur soon after merge.

Pages with no tech writer review

The documentation under /doc/solutions is created, maintained, copy edited, and merged by the Solutions Architect team.

AI-generated content

Community members can make AI-generated contributions to GitLab documentation, provided they follow the guidelines in our DCO or our CLA terms.

GitLab team members must follow the guidelines documented in the internal handbook.