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

Kshitij-Katiyar · 2023-10-10T08:20:40Z

Summary

Updated the message in webhookURL modal in the second step of the plugin setup

Screenshot

Old

New

Issue link

#939

What to test

Content of the modal in step 2 of plugin setup(webhook URL step)

How to test

Install the plugin
run jira setup
open the JIRA bot dm
Complete Step 1
Modal to be tested will be visible at the end of step 2

…lugin setup

codecov-commenter · 2023-10-10T08:50:47Z

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (6109662) 29.65% compared to head (6820a1c) 29.65%.
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #983      +/-   ##
==========================================
- Coverage   29.65%   29.65%   -0.01%     
==========================================
  Files          52       52              
  Lines        7792     7794       +2     
==========================================
  Hits         2311     2311              
- Misses       5285     5287       +2     
  Partials      196      196

Files	Coverage Δ
server/setup_flow.go	`0.00% <0.00%> (ø)`

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mickmister

LGTM

mickmister · 2023-10-10T15:13:45Z

server/setup_flow.go

@@ -400,7 +405,7 @@ func (p *Plugin) stepWebhook() flow.Step {
 			Color: flow.ColorPrimary,
 			Dialog: &model.Dialog{
 				Title:            "Jira Webhook URL",
-				IntroductionText: "Please scroll to select the entire URL if necessary.\n\n```{{.WebhookURL}}```\n\nOnce you have entered all options and the webhook URL, select **Create**",
+				IntroductionText: fmt.Sprintf("Please copy and use the link below as webhook URL. Once you have entered all options and the webhook URL, select **Create**. %s", lineBreak) + fmt.Sprintf("%s %s", lineBreak, webhookURL),


Putting a line break into a variable seems kind of overkill to me. Is this a functional requirement or for readability? The developer has to trace positional %s's to determine where those are being used. This is a small piece of code so it doesn't matter that much but just bringing it up for discussion

cwarnermm · 2023-10-11T20:13:29Z

server/setup_flow.go

@@ -400,7 +405,7 @@ func (p *Plugin) stepWebhook() flow.Step {
 			Color: flow.ColorPrimary,
 			Dialog: &model.Dialog{
 				Title:            "Jira Webhook URL",
-				IntroductionText: "Please scroll to select the entire URL if necessary.\n\n```{{.WebhookURL}}```\n\nOnce you have entered all options and the webhook URL, select **Create**",
+				IntroductionText: fmt.Sprintf("Please copy and use the link below as webhook URL. Once you have entered all options and the webhook URL, select **Create**. %s", lineBreak) + fmt.Sprintf("%s %s", lineBreak, webhookURL),


Suggested change

IntroductionText: fmt.Sprintf("Please copy and use the link below as webhook URL. Once you have entered all options and the webhook URL, select **Create**. %s", lineBreak) + fmt.Sprintf("%s %s", lineBreak, webhookURL),

IntroductionText: fmt.Sprintf("Please copy the link below as the webhook URL. Once you have entered all options and the webhook URL, select **Create**. %s", lineBreak) + fmt.Sprintf("%s %s", lineBreak, webhookURL),

@Kshitij-Katiyar - The updated text doesn't match the the popup dialog itself. The user only has 2 options: Cancel or Continue. The user isn't able to see any fields to populate.

I recognize that your PR hasn't made changes to that existing text. Are you open to updating your proposed text to provide more guidance to the user who encounters this dialog? If so, what would you recommend? What instructions on this dialog would help guide the user interested in setting up their Jira Webhook?

@cwarnermm This dialog is actually instructing the admin to interact with a form in Jira's UI, for installing the integration on that end. There is indeed no indication on the dialog itself, but I believe there is an instruction in a post that opens the dialog.

mattermost-plugin-jira/server/setup_flow.go

Lines 385 to 400 in 7534a97

WithPretext("##### :white_check_mark: Step 3: Setup Jira Subscriptions Webhook").

WithText(`To receive Jira event notifications in Mattermost Channels, you need to set up a single global ` +

"webhook, configured for all possible event triggers that you would like to be pushed into " +

"Mattermost. The plugin processes all data from the global webhook, and then routes the events " +

"to channels and users based on your subscriptions.\n\n" +

"1. Navigate to [Jira System Settings/Webhooks]({{.ManageWebhooksURL}}) (see _screenshot_), select **Create a WebHook** in the top right corner.\n" +

"2. Give your webhook a meaningful **Name** of your choice.\n" +

"3. **Status**: Enabled.\n" +

"4. Leave **URL** blank for the moment. Once you are done configuring the webhook options, come back " +

"here and select **View Webhook URL** to see the confidential URL.\n" +

"5. **Issue related events**: we recommend leaving the query at **All Issues**. Check **Comment**, " +

"**Attachment**, and **Issue** events. We recommend checking all of these boxes. These events will be " +

"further filtered by Mattermost subscriptions. Leave **Entity property**, **Worklog**, and **Issue " +

"link** events unchecked, they are not yet supported.\n" +

"6. Leave all other checkboxes blank.\n" +

"7. Select **View Webhook URL** to see the secret **URL** to enter in Jira, and continue.\n").

The last line "Select View Webhook URL" is referring to the button below the post that opens the dialog

Thanks, @mickmister, for this context.
@Kshitij-Katiyar - I approve this PR assuming the suggested change is applied to the dialog text. Thanks!

I'm thinking we should specify that the create button is in Jira though. For example:

Once you have entered all options and the webhook URL, select Create on the Jira create webhook page.

I agree with your proposal, @mickmister! Thank you! @Kshitij-Katiyar - Please note and update the text as proposed.

FYI there's an unresolved request in this thread, to make sure we mention the Create button is in Jira's UI

@Kshitij-Katiyar - Is this update something you're open to creating a PR for?

[mattermostGH-939]: Updated the message for webhookURL in step 2 of p…

58ea836

…lugin setup

Kshitij-Katiyar requested a review from mickmister as a code owner October 10, 2023 08:20

Kshitij-Katiyar added 2 commits October 10, 2023 13:56

[mattermostGH-939]: Fixed lint

b635048

[mattermostGH-939]: Fxied CI errors

6820a1c

Kshitij-Katiyar added 2 commits October 10, 2023 14:30

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

862a229

[mattermostGH-939]: Fixed linting errors

7534a97

mickmister requested a review from cwarnermm October 10, 2023 15:11

mickmister approved these changes Oct 10, 2023

View reviewed changes

cwarnermm reviewed Oct 11, 2023

View reviewed changes

cwarnermm mentioned this pull request Oct 11, 2023

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

Closed

cwarnermm approved these changes Oct 12, 2023

View reviewed changes

hanzei added the 4: Reviews Complete All reviewers have approved the pull request label Dec 5, 2023

hanzei added this to the v4.1.0 milestone Dec 5, 2023

hanzei merged commit e1430fa into mattermost:master Dec 5, 2023
7 checks passed

mickmister mentioned this pull request Dec 20, 2023

Bump version to 4.1.0 #997

Merged

raghavaggarwal2308 deleted the GH-939 branch July 25, 2024 08:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Kshitij-Katiyar commented Oct 10, 2023

codecov-commenter commented Oct 10, 2023

mickmister left a comment

mickmister Oct 10, 2023

cwarnermm Oct 11, 2023

cwarnermm Oct 11, 2023

mickmister Oct 11, 2023

cwarnermm Oct 12, 2023

mickmister Oct 13, 2023

cwarnermm Oct 13, 2023

mickmister Dec 6, 2023

cwarnermm Dec 6, 2023

	IntroductionText: fmt.Sprintf("Please copy and use the link below as webhook URL. Once you have entered all options and the webhook URL, select Create. %s", lineBreak) + fmt.Sprintf("%s %s", lineBreak, webhookURL),
	IntroductionText: fmt.Sprintf("Please copy the link below as the webhook URL. Once you have entered all options and the webhook URL, select Create. %s", lineBreak) + fmt.Sprintf("%s %s", lineBreak, webhookURL),

	WithPretext("##### :white_check_mark: Step 3: Setup Jira Subscriptions Webhook").
	WithText(`To receive Jira event notifications in Mattermost Channels, you need to set up a single global ` +
	"webhook, configured for all possible event triggers that you would like to be pushed into " +
	"Mattermost. The plugin processes all data from the global webhook, and then routes the events " +
	"to channels and users based on your subscriptions.\n\n" +
	"1. Navigate to [Jira System Settings/Webhooks]({{.ManageWebhooksURL}}) (see _screenshot_), select Create a WebHook in the top right corner.\n" +
	"2. Give your webhook a meaningful Name of your choice.\n" +
	"3. Status: Enabled.\n" +
	"4. Leave URL blank for the moment. Once you are done configuring the webhook options, come back " +
	"here and select View Webhook URL to see the confidential URL.\n" +
	"5. Issue related events: we recommend leaving the query at All Issues. Check Comment, " +
	"Attachment, and Issue events. We recommend checking all of these boxes. These events will be " +
	"further filtered by Mattermost subscriptions. Leave Entity property, Worklog, and **Issue " +
	"link** events unchecked, they are not yet supported.\n" +
	"6. Leave all other checkboxes blank.\n" +
	"7. Select View Webhook URL to see the secret URL to enter in Jira, and continue.\n").

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

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

Conversation

Kshitij-Katiyar commented Oct 10, 2023

Summary

Screenshot

Old

New

Issue link

What to test

How to test

codecov-commenter commented Oct 10, 2023

Codecov Report

mickmister left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment