Update documentation for the code Merge Request Report Widget component after Working Group improvements
Problem to solve
We have a section of our documentation that covers the basic functionality of the initial reusable component for Merge Request widgets. https://docs.gitlab.com/ee/development/new_fe_guide/modules/widget_extensions.html
During the past two Quarters, we've been working on improving the state of the report widgets by adding support to the specs in the UX Framework:
- Engineering effort: &6647 (closed)
- Report regions design guidelines defined in the Pajamas Design System: https://design.gitlab.com/regions/merge-request-reports/
The documentation needs to be updated to help other authors in the future to understand how to properly leverage the new functionality to fulfill the requirements of the UX Framework.
Goal
Provide enough information for any new author, looking to refactor an existing or write a new MR Report Widget, is able to learn the basics of how to leverage all the options provided by the core component to do so.
Further details
Concepts to be covered in the new docs:
- Levels: how to specify the content for each level of content
- Content sections: how to specify content for each of the avalable sections
- Status / icons
- Subject
- Title and description
- Text
- Meta
- Actions
- Polling
- ....anything else relevant
Proposal
Who can address the issue
- @iamphill has been the core contributor for these advances
- @jannik_lehmann volunteered to help Phil