Document code design of approval rules
What does this MR do?
In this development document, major parts of the application being used to implement the approval rules feature is explained in a high level manner.
The goal is to help contributors understand the code design easier and to also help those familiar with the codebase to see if there are parts to improve.
This doesn't document the entire feature yet as it's missing other parts specified in the TODO section of the document.
Questions for reader
- Does it help?
- If it helps, do you think it helps to be used for other features in our application?
- Are you willing to maintain this document?
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.
Edited by Marcia Ramos