This document explains the workflow of the Technical Writing team. Consider it an extension of the Engineering workflow which you should be familiar with. For the workflow that applies to everyone please see PROCESS.md.
In order to avoid situations where a feature slips through without documentation, there must be a clear, defined process.
A checklist is present in the MR template to make sure that documentation is part of the MR, but sometimes there are some legitimate reasons to defer documentation from the initial MR which then makes it easy to get lost.
Two things you need to remember:
Documentationlabel assigned along with other workflow labels.
Deliverablelabels, which is important so that the issue is shown in the Documentation issue board. Make sure to link back to the implementation MR and the initial issue for a reference. This will save time from searching information needed to write the docs.
The GitLab.org group issue board can then be used to schedule what issues to work on.
There are various types of issues you are called to work on:
Below is the current priority of scheduling issues:
Labels are described in our Contribution guide.
The documentation should be ready by the 8th for the kickoff call and the link added to the release post of the upcoming release. For more information on the product development timeline, see the Engineering handbook.