mattermost-plugin-jira icon indicating copy to clipboard operation
mattermost-plugin-jira copied to clipboard

Jira setup have minor UX issues with the subscriptions step

Open DHaussermann opened this issue 2 years ago • 16 comments

The subscriptions step pf setup should be improved. It currently looks like this image

There are 2 issues here.

  1. Can the string the user must copy not wrap within the text area of the modal? It seem quite clunky that we instruct the user to scroll over.
  2. Can we add a button to clipboard the value as we done in other areas of the setup wizard? It would seem smoother for the user to be given a button that copies for them. We have buttons elswhere in the setup that have this styling... image

DHaussermann avatar May 07 '23 22:05 DHaussermann

@DHaussermann The string mentioned to be improved in the issue is present in the modal, which renders while setting up the plugin and displays the URL to be used for creating the webhook. One easy fix that I tried was to use markdown here, like next line which is used in the below example of complete.html url you have given, but this is not getting rendered as modal, which is displaying the URL here, and it is getting generated by the backend code, which is not supporting this markdown. @mickmister Can you please suggest something else that might work here?

Kshitij-Katiyar avatar Sep 12 '23 10:09 Kshitij-Katiyar

@Kshitij-Katiyar I think the scrolling thing is the most important thing to solve here, as that modal is simply not supposed to work that way.

Having it rendered as a markdown "link" instead of "code" should let the user right-click and select "Copy link address". Not sure if we need anything else here. The "click here to copy" seems overkill for the interactive dialogs.

which is not supporting this markdown.

I'm not sure what this means

mickmister avatar Sep 13 '23 00:09 mickmister

@mickmister is this what we are looking for ? Screenshot from 2023-09-13 13-56-33

Kshitij-Katiyar avatar Sep 13 '23 08:09 Kshitij-Katiyar

@mickmister is this what we are looking for?

I was thinking it would show the full URL. This screenshot makes me think I should click that link to learn more about webhook URLs. @DHaussermann What do you think?

mickmister avatar Sep 13 '23 15:09 mickmister

@mickmister What do you think about this Screenshot from 2023-09-18 16-05-19

Kshitij-Katiyar avatar Sep 18 '23 10:09 Kshitij-Katiyar

@Kshitij-Katiyar I'm thinking the URL should be on its own after the paragraph. Otherwise, it's difficult to parse the explanation text versus the text intended for computers (the URL). This sort of thing is not really my specialty though. @DHaussermann What do you think?

mickmister avatar Sep 19 '23 21:09 mickmister

@mickmister @DHaussermann I tried to keep it in a separate paragraph by putting /n before and after the URL but for some reason, this is not working maybe this is not supported in the modal generated from the backend I guess

Screenshot from 2023-09-20 11-34-17

Kshitij-Katiyar avatar Sep 20 '23 06:09 Kshitij-Katiyar

@Kshitij-Katiyar There may be an issue in the way the dialog is rendering markdown https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/interactive_dialog/dialog_introduction_text.tsx

Another thought, does the triple backtick code block as an option:

https://mymattermost.com/plugins/jira/webhook

mickmister avatar Sep 28 '23 17:09 mickmister

@mickmister Triple backticks are currently in use in the master branch and they are not working as intended. As you said there may be an issue in the way the dialog is rendering markdown. Screenshot from 2023-09-29 16-08-10

Kshitij-Katiyar avatar Sep 29 '23 11:09 Kshitij-Katiyar

@Kshitij-Katiyar Okay how about we do the hyperlink approach like https://github.com/mattermost/mattermost-plugin-jira/issues/939#issuecomment-1723156371, but we put the link at the end of the paragraph?

mickmister avatar Sep 29 '23 14:09 mickmister

@Kshitij-Katiyar sorry for the late reply. For me, I would agree with @mickmister, we should keep the entire string visible to the user. hiding it could make some people uncomfortable as it makes it more diffcult to double check what you're doing.

DHaussermann avatar Oct 02 '23 21:10 DHaussermann

@mickmister @DHaussermann Please share your opinion about this setup. There is a '\n' between the Paragraph and link but it is not working Screenshot from 2023-10-05 14-27-56(1)

Kshitij-Katiyar avatar Oct 05 '23 09:10 Kshitij-Katiyar

@Kshitij-Katiyar , I don't this will work well without the line-break. Can we explore why it's not working?

mkdbns avatar Oct 06 '23 16:10 mkdbns

@mkdbns @mickmister I worked out an approach for adding a new line. Please share your views on this Screenshot from 2023-10-09 17-47-16

Kshitij-Katiyar avatar Oct 09 '23 12:10 Kshitij-Katiyar

@Kshitij-Katiyar Are you able to open a PR so we can see the changes thus far?

@cwarnermm Do you have any advice on how we should word/structure the above message? This is formatted markdown in the modal

mickmister avatar Oct 10 '23 04:10 mickmister

Thanks, @mickmister. I've provided text feedback via https://github.com/mattermost/mattermost-plugin-jira/pull/983

cwarnermm avatar Oct 11 '23 20:10 cwarnermm

Closing via https://github.com/mattermost/mattermost-plugin-jira/pull/983

raghavaggarwal2308 avatar Jul 25 '24 08:07 raghavaggarwal2308