Add documentation for docs-with-code workflow
What does this MR do?
WIP: This is the first draft of adding an "optional mandatory workflow" for always including docs with code changes. It's optional, but if teams choose to employ this workflow, docs-with-code would be mandatory within that team/group.
An example of the pitfalls of splitting docs from code MRs: gitlab-foss!31530 (comment 235097369). I spent a long time this evening trying to figure out what went on with the docs and the feature, and it's what drove me to finally put everything aside and start this MR so that the technical writers can begin offering this workflow to their groups/stages.
This is a lot of discussion regarding this in the issue linked below.
Related issues
Related to #198320 (closed)
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.