[License Compliance MR Widget Extension] - Better document loading states
The docs for license compliance are not very clear on the behind the scenes behavior of the Security widgets. In particular there are some behaviors that cause the user to think the feature is broken #360290 (closed)
Possible UI states when a new merge request is newly created
- While the pipeline is in progress, the widgets will continue to show a spinner with a
loading state - Once the pipeline is complete, but still parsing the results in the background it will continue showing a
loading state. This causes the user to think the feature is broken because they have an all green pipeline yet "hanging spinner w/ loading message" In reality we are still parsing the results in the background. - The final state is pipeline complete, and results parsed state. This is when we show the widget with populated data.
Possible solutions
- Improve the text copy in the loading state to make things clearer
- Improve the docs to clarify the differences
- Improve the UI by having 3 states. (Loading, Pipeline/Progress in Progress, and Complete)
Implementation Plan
- Improve the docs to clarify the differences
Edited by -