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

Add user feedback #723

Merged
merged 10 commits into from
Aug 10, 2022
Merged

Add user feedback #723

merged 10 commits into from
Aug 10, 2022

Conversation

Janpot
Copy link
Member

@Janpot Janpot commented Aug 2, 2022

Lay the groundwork for a potential user feedback flow.

Screen.Recording.2022-08-02.at.15.04.00.mov

@render
Copy link

render bot commented Aug 2, 2022

@oliviertassinari oliviertassinari requested a deployment to feedback - toolpad-db PR #723 August 2, 2022 13:05 — with Render Abandoned
<Route path="/app/:appId/*" element={<AppWorkspace />} />
</Routes>
</BrowserRouter>
<UserFeedback>
Copy link
Member

@apedroferreira apedroferreira Aug 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i didn't immediately understand this was a context provider from the component name - maybe we could make it more explicit?
nevermind it has the dialog too - i think it's fine, usually i would just have the provider and the component completely separate, so it confused me at first but nothing wrong with this approach

@prakhargupta1
Copy link
Member

Both interactions look good and well positioned.

A copy change suggestion:
Need a specific feature ? You can open a feature request over at our GitHub repo or upvote from the existing requests.

For components, can we somehow take users to a page where they can vote among many components ? If not possible on GitHub then may be Notion ?

@Janpot
Copy link
Member Author

Janpot commented Aug 4, 2022

For components, can we somehow take users to a page where they can vote among many components ? If not possible on GitHub then may be Notion ?

We could make a GitHub issue for each component?

@prakhargupta1
Copy link
Member

prakhargupta1 commented Aug 4, 2022

We could make a GitHub issue for each component?

This seems straight forward, but won't it become additional work to manage ? I mean for the scenario when the component wasn't listed there: a user clicks on another component and creates an issue for the component they need, but it won't reflect in this catalog (additional work to show it) and may miss some votes.

But since there are only a certain number of popular components users will request first, we can start with a list of top-10 each linking to a GH issue.
Later on we can have a generic: Request a component that can take users to a GH tag having other components' issues.

@prakhargupta1
Copy link
Member

Cool, I'll share the list of components.

The top-right position is also suitable for:

  1. linking documentation
  2. showing current version of Toolpad

Should we have a small menu there or where else can we place these? @gerdadesign

@gerdadesign
Copy link
Member

gerdadesign commented Aug 5, 2022

Screen Shot 2022-08-05 at 11 24 41 AM

Is something like this what you're looking for?

  • other icons in top bar appear to be 100% black at 24px square
  • tooltip (these appear to be grey in other places in toolpad) that says "Help and resources"
  • do you think editor and releases can be collapsed into this menu?
  • would "Submit feedback" link out to this aforementioned singular github issue or to https://github.com/mui/mui-toolpad/issues ?

@Janpot
Copy link
Member Author

Janpot commented Aug 5, 2022

  • do you think editor and releases can be collapsed into this menu?

It's possible, we should probably take a look at app navigation as a whole as well, but I would leave it out of the scope of this PR.

either https://github.com/mui/mui-toolpad/issues or https://github.com/mui/mui-toolpad/issues/new?assignees=&labels=status%3A+needs+triage&template=2.feature.yml

@prakhargupta1
Copy link
Member

Isn't this Help icon more suited in the top right corner ?

Also, instead of Submit feedback we can have:

  1. Report bug: https://github.com/mui/mui-toolpad/issues/new?assignees=&labels=status%3A+needs+triage&template=1.bug.yml

  2. Request or upvote feature: https://github.com/mui/mui-toolpad/issues/new?assignees=&labels=status%3A+needs+triage&template=2.feature.yml

Rest everything else looks good.
Another out of PR thought: Shouldn't the EDITOR be shown selected when the user is on Editor tab ?

@gerdadesign
Copy link
Member

Isn't this Help icon more suited in the top right corner ?

That was my initial instinct as well, but it felt a little confusing sitting next to App deployment functions — the help icon isn't directly related to Previewing the app, so I moved it. In general though I agree that overall navigational elements could be revisited.

Request or upvote feature: https://github.com/mui/mui-toolpad/issues/new?assignees=&labels=status%3A+needs+triage&template=2.feature.yml

This link goes directly to Request feature, so to add the option to upvote seems like it should be a step back to https://github.com/mui/mui-toolpad/issues ?

Screen Shot 2022-08-05 at 12 34 23 PM

@prakhargupta1
Copy link
Member

prakhargupta1 commented Aug 5, 2022

In general though I agree that overall navigational elements could be revisited.

Agree, for now, let's go ahead with what you shared.

This link goes directly to Request feature, so to add the option to upvote seems like it should be a step back to https://github.com/mui/mui-toolpad/issues ?

Agree, let's do this.

@oliviertassinari
Copy link
Member

oliviertassinari commented Aug 6, 2022

A quick benchmark on the support help:

Product Position Close Open
Ahrefs Bottom right Screenshot 2022-08-06 at 14 23 19 Screenshot 2022-08-06 at 14 23 22
Figma Bottom right Screenshot 2022-08-06 at 14 23 03 Screenshot 2022-08-06 at 14 23 09
Retool Bottom right Screenshot 2022-08-06 at 14 24 21 Screenshot 2022-08-06 at 14 24 26
Ashby Bottom left Screenshot 2022-08-06 at 14 26 08 Screenshot 2022-08-06 at 14 26 13

I had a look as Linear too, but I found it horrible (you have to move your cursor all the way from the left side to the right side between the open and close state, WUT, they don't want you to use it 🙃).

@gerdadesign
Copy link
Member

We could certainly pin it to the bottom! Does this get in the way of any functionality?
Screen Shot 2022-08-06 at 9 54 17 AM

@Janpot Janpot changed the title Add user feedback dialog Add user feedback Aug 8, 2022
@prakhargupta1
Copy link
Member

More points to note:

  1. If we show it next to Releases tab then during App preview scenario the header bar would be missing => help icon would be missing.
  2. In the App board view there is no Editor, Releases tab, and we will have to horizontally shift help icon.

So keeping it at bottom right as an overlay (as shared by Gerda) appears to be the best placement.

@Janpot
Copy link
Member Author

Janpot commented Aug 8, 2022

Does this get in the way of any functionality?

Probably yes, e.g. when selecting a component that has several properties:

Screenshot 2022-08-08 at 09 38 44

Personally not a big fan of those floating help/chat buttons. They tend to get in the way, you have to design every screen in your application around them. The header is a surface that is present on every page, wouldn't that be the ideal location and where people would naturally look?

There's a bit of a selection bias in the above benchmark, adding a few more:

Product Position Screen
appsmith header Screenshot 2022-08-08 at 09 46 56
grafana bottom left Screenshot 2022-08-08 at 09 49 36
google sheets application menu Screenshot 2022-08-08 at 09 52 44
gmail header top right Screenshot 2022-08-08 at 09 55 36

@prakhargupta1
Copy link
Member

Ok. So if we place it on the header bar, then it has to be in the right corner for consistency and that's how some other products have done it.

And, it will be missing from the preview view, which should be ok as it is app preview and the entire header bar won't be there.

Screenshot 2022-08-08 at 4 23 37 PM

I think we can close this here.

@Janpot Janpot merged commit 9041450 into master Aug 10, 2022
@Janpot Janpot deleted the feedback branch August 10, 2022 10:19
@Janpot Janpot mentioned this pull request Aug 10, 2022
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants