Customize Technical Writing review prompts by section
What does this MR do and why?
Solutions and Development docs do not need reviews from Technical Writers, but MRs with edits in these sections should follow specialized directions.
This MR refactors the documentation Dangerfile to return different messages based on the file paths that were changed in the MR.
Closes #428675 (closed) and #431248 (closed).
Screenshots or screen recordings
| Solutions page edit | Development page edit | Regular page edit | Multiple section edits |
|---|---|---|---|
 |
 |
 |
 |
How to set up and validate locally
- Check out this branch
- Edit a docs page under
/doc/solutions, and commit it. - Run Danger and verify you see a solutions-specific message:
bin/rake danger_local
Remove your test commit, and repeat steps 2-3 for a development page (anything under /doc/development), and repeat again with any other doc page (anything in /doc not under solutions or development).
- The Development page should have a development-specific message.
- The other page should have the same "Documentation Review" message as we currently have (example).
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.