Dangerfile 1.63 KB
Newer Older
1 2
# frozen_string_literal: true

3
docs_paths_to_review = helper.changes_by_category[:documentation]
4 5 6

unless docs_paths_to_review.empty?
  message 'This merge request adds or changes files that require a ' \
7
    'review from the Docs team.'
8 9

  markdown(<<~MARKDOWN)
10
## Docs review
11 12 13 14 15

The following files require a review from the Documentation team:

* #{docs_paths_to_review.map { |path| "`#{path}`" }.join("\n* ")}

Marcia Ramos's avatar
Marcia Ramos committed
16 17 18 19
When your content is ready for review, assign the MR to a technical writer
according to the [DevOps stages](https://about.gitlab.com/handbook/product/categories/#devops-stages)
in the table below. If necessary, mention them in a comment explaining what needs
to be reviewed.
20

21 22
| Tech writer  | Stage(s)                                                     |
| ------------ | ------------------------------------------------------------ |
Marcia Ramos's avatar
Marcia Ramos committed
23
| `@marcia`    | ~Create ~Release + ~"development guidelines"                 |
24
| `@axil`      | ~Distribution ~Gitaly ~Gitter ~Monitor ~Package ~Secure |
25 26
| `@eread`     | ~Manage ~Configure ~Geo ~Verify                              |
| `@mikelewis` | ~Plan                                                        |
Mike Lewis's avatar
Mike Lewis committed
27

Marcia Ramos's avatar
Marcia Ramos committed
28 29 30 31
You are welcome to mention them sooner if you have questions about writing or
updating the documentation. GitLabbers are also welcome to use the
[#docs](https://gitlab.slack.com/archives/C16HYA2P5) channel on Slack.

Mike Lewis's avatar
Mike Lewis committed
32
If you are not sure which category the change falls within, or the change is not
Marcia Ramos's avatar
Marcia Ramos committed
33
part of one of these categories, mention one of the usernames above.
34 35 36 37 38 39
  MARKDOWN

  unless gitlab.mr_labels.include?('Documentation')
    warn 'This merge request is missing the ~Documentation label.'
  end
end