Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jira setup have minor UX issues with the subscriptions step #939

Closed
DHaussermann opened this issue May 7, 2023 · 17 comments
Closed

Jira setup have minor UX issues with the subscriptions step #939

DHaussermann opened this issue May 7, 2023 · 17 comments
Labels
Type/Bug Something isn't working
Milestone

Comments

@DHaussermann
Copy link

DHaussermann commented May 7, 2023

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 DHaussermann added Triage Type/Bug Something isn't working labels May 7, 2023
@Kshitij-Katiyar Kshitij-Katiyar added this to the v4.1.0 milestone Sep 7, 2023
@Kshitij-Katiyar
Copy link
Contributor

Kshitij-Katiyar commented Sep 12, 2023

@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?

@mickmister
Copy link
Contributor

@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

@Kshitij-Katiyar
Copy link
Contributor

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

@mickmister
Copy link
Contributor

@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?

@Kshitij-Katiyar
Copy link
Contributor

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

@mickmister
Copy link
Contributor

@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?

@Kshitij-Katiyar
Copy link
Contributor

Kshitij-Katiyar commented Sep 20, 2023

@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

@mickmister
Copy link
Contributor

@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

@Kshitij-Katiyar
Copy link
Contributor

@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

@mickmister
Copy link
Contributor

@Kshitij-Katiyar Okay how about we do the hyperlink approach like #939 (comment), but we put the link at the end of the paragraph?

@DHaussermann
Copy link
Author

@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.

@Kshitij-Katiyar
Copy link
Contributor

@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)

@mkdbns
Copy link

mkdbns commented Oct 6, 2023

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

@Kshitij-Katiyar
Copy link
Contributor

Kshitij-Katiyar commented Oct 9, 2023

@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

@mickmister
Copy link
Contributor

@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

Kshitij-Katiyar added a commit to Brightscout/mattermost-plugin-jira that referenced this issue Oct 10, 2023
Kshitij-Katiyar added a commit to Brightscout/mattermost-plugin-jira that referenced this issue Oct 10, 2023
Kshitij-Katiyar added a commit to Brightscout/mattermost-plugin-jira that referenced this issue Oct 10, 2023
Kshitij-Katiyar added a commit to Brightscout/mattermost-plugin-jira that referenced this issue Oct 10, 2023
Kshitij-Katiyar added a commit to Brightscout/mattermost-plugin-jira that referenced this issue Oct 10, 2023
@cwarnermm
Copy link
Member

Thanks, @mickmister. I've provided text feedback via #983

hanzei pushed a commit that referenced this issue Dec 5, 2023
#983)

* [GH-939]: Updated the message for webhookURL in step 2 of plugin setup

* [GH-939]: Fixed lint

* [GH-939]: Fxied CI errors

* [GH-939]: Improved the use of sprintf for the content of modal

* [GH-939]: Fixed linting errors
@avas27JTG avas27JTG modified the milestones: v4.1.0, next milestone Dec 21, 2023
@raghavaggarwal2308
Copy link
Contributor

Closing via #983

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type/Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

8 participants