In the merge request widget, when using the merge trains feature, below the button Start merge train when pipeline succeeds it reads This merge request will start a merge train when pipeline X succeeds.
The button hasn't been clicked yet, so saying that it “will” seems incorrect. It also looks redundant to repeat the same information twice.
How
Look into the usefulness of that message and if it's possible to remove it or reword it.
A common interpretation of the text is When the pipeline in progress succeeds, the merge train will Start/MR will be added to a train. This is the same as the message communicated through the button text as well.
@v_mishra As we are preparing for gitlab-com/www-gitlab-com#11204 (closed) where the rest of open issues from the MR async design critique will hopefully be handled, we want to ensure that all these open issues have clear design proposals. At first glance it seems like this is actually a bug where the message should not be visible in this state. However, it seems like the next state would be this:
I thus wonder if the design proposal should be to just completely get rid of this message, as it doesn't seem like it's correct in this state, and we already communicate this differently in the state where it would actually be correct. What do you think?
@mvanremmerden I get your point, message does seem redundant. If we could only retain the More information link in some way that'd be helpful. There should be some way for users to get to the documentation to understand what would starting a merge train really do.
@v_mishra That's a very interesting point indeed. I wonder if this should be one-time information that we could solve with e.g. a dismissable banner attached to the widget, like this.
That would allow us to ensure that each user has the chance to see this when they start learning about the feature, but keeps this space clean for users who are already aware of how it works.
@mvanremmerden putting the info in dismissible banner seems like a great idea
The message could go like:
ℹ️ This action will start a merge train when pipeline X succeeds and add the merge request to it. More information.
(May be more refined).
Also, I just noticed this is labeled ~"group::continuous integration" .
Looks like the problem is still being validated as per the point in the KR - [ ] Ensure that all 29 open issues are valid, have clear proposals, and are ready to be implemented.
I wanted to confirm if this is to be taken up by continuous integration team for implementation?
@v_mishra I like the general direction, but if we put the focus on trying to educate users about how merge trains work, I wonder if we need to put the focus more on explaining what this actually does behind the scenes. Maybe something closer to this sentence from the docs:
A merge train is a queued list of merge requests, each waiting to be merged into the target branch.
The audience here would really be first-time users who we need to educate about the concept once, so that in the future they (1) know the general concept and (2) know where to go for deeper information (our docs). Maybe @aqualls has an opinion about this as well, as she has been working on this widget for quite some time now.
I wanted to confirm if this is to be taken up by continuous integration team for implementation?
That's exactly what we are hoping for. We are currently trying to ensure that each of these issues is ready for implementation, so that when the quarter with the new OKRs start, each of the designers can put these issues in front of their PMs to be considered for the next milestones.
@pedroms after discussing with @thaoyeager I figured that we couldn't get to the implementation of #325529 (closed) before Q3. I think we should provide an MVC solution in the meantime.
@v_mishra UI text is easier to iterate on, so that makes sense to me. In any case, will you have capacity to do solution validation for #325529 (closed)? Or did you also include that when you mentioned “implementation”?
@jreporter@mvanremmerden@pedroms after conducting a quick answer test on UserTesting, it appears that a common interpretations of the message
This merge request will start a merge train when pipeline X succeeds
is When the pipeline in progress succeeds, the merge train will Start/MR will be added to a train. This is also what we communicate through the button text Start merge train when pipeline succeeds.
The message doesn't clarify the reason for waiting on the running pipeline and users still have to click on the more information link to understand the need to wait on the running pipeline(because its a merge request pipeline).
I've created another issue to improve the messaging based on the insight from this issue: #334131 (closed)