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

[Feature]: Support a way to reference the widget user needs to drag in the deprecation message #14380

Closed
1 task done
dilippitchika opened this issue Jun 8, 2022 · 8 comments · Fixed by #14532
Closed
1 task done
Assignees
Labels
Enhancement New feature or request UI Building Product Issues related to the UI Building experience Verified When issue is retested post its fixed

Comments

@dilippitchika
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Summary

Within the deprecation message, we wish to inform the user that they need to drag a specific widget to upgrade this.
App viewers pod needs a way to provide the name of the widget the user needs to update to.

The message can be the following -
The widget you are currently using is now deprecated. You can drag a new button widget and configure it to work in place of this widget.

But also check with @jnikhila to finalise.

Qualities of a good message

  1. Explains what the problem is with the current widget
  2. Gives a clear next step on what they immediately need to do
  3. Provides a way to learn more about the change

Why should this be worked on?

This will help us communicate to the user that they must drag the specific widget which maybe sometimes different than the current widget they are working on.

Example

  1. Form button widget doesn't exist anymore a user will have to drag a button widget
  2. Input widget is broken down into multiple widgets like phone and currency, a user who is using the phone from an older input widget must see the deprecation message show that they need to drag a phone widget and not an input widget.
@dilippitchika dilippitchika added Enhancement New feature or request UI Building Product Issues related to the UI Building experience labels Jun 8, 2022
@rahulramesha
Copy link
Contributor

@jnikhila for the message for deprecation widgets, we will need a message along the lines mentioned in the description above.
Where in user will have to drag and drop a new widget (Sometimes the widget that needs to be dragged is different from the deprecated widget) and also mention that they will have to configure it manually, does the message mentioned by @dilippitchika sound good?
The widget you are currently using is now deprecated. You can drag a new [WIDGET_TYPE] widget and configure it to work in place of this widget.

@jnikhila
Copy link

jnikhila commented Jun 10, 2022

@rahulramesha - The message looks good, just changed it a bit:

The [WIDGET_TYPE] widget you are currently using is now deprecated. You can drag a new version of the [WIDGET_TYPE] widget and configure it in place of the deprecated widget.

CC: @dilippitchika

@rahulramesha
Copy link
Contributor

@jnikhila Thanks for the updated message, I have made a slight modification by removing, version of the because some times we replace widgets with a new type of widget and that might confuse the user.

@dilippitchika @somangshu I have added a way to reference the replacement widget in the message and updated the message,
image
I will be pushing to merge it in, you could verify the message at the https://appsmith-git-deprecationwarningmessageupdate-get-appsmith.vercel.app/app/deprecated-warning-message-test/deprecated-widgets-6274de107c6b4e16b81a24a3/edit.

I have also added a placeholder for a link in the code. Will need to just configure the link once the doc is ready.
image

Please let me know if this requires any changes.
cc: @rohitagarwal88

@dilippitchika
Copy link
Contributor Author

Thanks @rahulramesha this works,

@jnikhila just extending the discussion we had for - #14462

We need a document which explains the following things, please discuss with rahul as well once.

  1. What does a deprecrated widget mean? -- This should explain that the widget will keep working, but we will stop supporting it going forward
  2. How to upgrade by dragging and reconfiguring? -- This should show a user how they configure a new widget and remove the old one.

@jnikhila
Copy link

jnikhila commented Jun 15, 2022

@dilippitchika - understood. I'll schedule a call to understand the doc needs with @rahulramesha and yourself and take it ahead.

@rahulramesha - for the message, we should keep the heading as before and just modify the old message with the new message as below.

Heading - Stay Up-to-date 
Message -  The [WIDGET_TYPE] widget you are currently using is now deprecated. You can drag a new [WIDGET_TYPE] widget and configure it in place of the deprecated widget.

Just a suggestion - I'm not sure if we can do some UI highlighting for the old widget type that is deprecated and the new widget type with which the user has to replace the old widget. It'll quickly grab the user's attention. As in the current message, it looks like plain text without having an emphasis on the types of widgets that I as a user had to replace.

Something like this:

Heading - Stay Up-to-date
Message - The Circular Progress widget you are currently using is now deprecated. You can drag a new Progress widget and configure it in place of the deprecated widget.

CC: @dilippitchika - what do you think?

@rahulramesha
Copy link
Contributor

rahulramesha commented Jun 15, 2022

@jnikhila, we can have a heading, But from what the users are mentioning on discord. The Heading Stay Up-to-date is calling on the user to take action immediately and update the widget to keep the app working.
We don't want to give that impression to the user, as the app they have will continue to work as is. We just want the user to be aware that the widget is deprecated and they can replace it if they choose to.

@jnikhila
Copy link

jnikhila commented Jun 15, 2022

@rahulramesha - understood, but we want the users to move to the new version of widgets, right or we'll continue to support the users with deprecated widgets for an indefinite time period?

Instead of Stay Up-to-date, we can use Update Available. Let me know what you think? The heading tells users upfront what is expected.

Based on our discussion, let's not keep a heading for now.

@close-label close-label bot added the QA Needs QA attention label Jun 23, 2022
@Sripriya93 Sripriya93 added Verified When issue is retested post its fixed and removed QA Needs QA attention labels Jun 24, 2022
@Sripriya93
Copy link

Verified all the widgets placed in Deprecation application
Input1
Select1
DatePicker1
Icon1
FilePicker1
MultiSelect1
ProgressBar1
CircularProgress1

Working fine, moving to verified.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request UI Building Product Issues related to the UI Building experience Verified When issue is retested post its fixed
Projects
None yet
4 participants