Improve docs review workflow for merge requests
Problem
For merge requests that touch documentation files (e.g. files in /doc
) for the customers-gitlab-com project, frontend or backend engineers (and potentially others) could provide the review and give the approval. We updated the dangerfile configuration in https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/8882+ to suggest either role, frontend or backend, when these files are touched.
In practice, this change may have added to confusion because instead of suggesting one or the other, both roles are suggested. For example, if an MR only updates one doc file, both frontend and backend reviewers and maintainers will be suggested by Reviewer Roulette. That was the case in this MR.
Proposal
To address this confusion, use a separate category, documentation, for /docs
files:
-
Introduce a :documentation
category in the Dangerfile- Use this new category here in the Dangerfile config instead of using both
:frontend
and:backend
. - MR: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10458+
- Use this new category here in the Dangerfile config instead of using both
-
Make all fulfillment engineers available as documentation reviewers. - Open an MR in https://gitlab.com/gitlab-com/www-gitlab-com to add the necessary
- reviewer documentation
line undercustomers-app
for all fulfillment engineers. - MR: gitlab-com/www-gitlab-com!135377
- Open an MR in https://gitlab.com/gitlab-com/www-gitlab-com to add the necessary
Result
A clearer workflow for documentation reviews in the CDot project.