Housekeeper: Add documentation on change’s properties
What does this MR do and why?
This MR improves the documentation on the topic of a change
object. A change
object can have various properties set on it, some of these are mandatory, but it has not been called out explicitly in the documentation till now.
This can serve as a good improvement to increase adoption of housekeeper.
Preview:
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 Manoj M J