Skip to content

Update danger for architecture docs

Marcel Amirault requested to merge docs-update-tw-danger into master

What does this MR do and why?

As seen in any MR touching blueprint docs, the danger message still recommends TW review, which I do not believe is required. Ex: !142931 (comment 1745558793):

  • This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

The danger warning already contains information about getting a Coach to review, so I think all we need to do is skip the docs review section, and make the message the same as the /doc/development section.

I've also reordered the code slightly so that everything is ordered alphabetically.

The handbook guidance for this has been updated to align everything and make it clear that TW review is not needed: gitlab-com/content-sites/handbook!3745 (merged)

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Edited by Marcel Amirault

Merge request reports