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

Added Help button #6560

Merged
merged 19 commits into from
Oct 20, 2022
Merged

Added Help button #6560

merged 19 commits into from
Oct 20, 2022

Conversation

hotzenklotz
Copy link
Member

The PR adds a small help button to the UI. Users can send us a question or give feedback.

URL of deployed dev instance (used for testing):

  • https://___.webknossos.xyz

Steps to test:

  • Click on help button
  • Write a something nice
  • Click "Send"
  • Check you emails if you were CCed on the help email

Issues:


(Please delete unneeded items, merge only when none are left open)

@hotzenklotz
Copy link
Member Author

I could not really decide on a color scheme. Here are the two options I tried:

  1. default color scheme of antd's <Alert type="info">:

image

  1. More prominent color scheme, similar to antd's primary <Button>:

image

@hotzenklotz hotzenklotz changed the title WIP: Added Help button Added Help button Oct 18, 2022
@hotzenklotz hotzenklotz enabled auto-merge (squash) October 18, 2022 12:54
…p_button

* 'master' of github.com:scalableminds/webknossos:
  Reload histogram when reloading layer (#6537)
Copy link
Member

@fm3 fm3 left a comment

Choose a reason for hiding this comment

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

Backend LGTM :)

Two questions:

  • Should the user maybe get a slightly different email along the lines of “we received the following feedback message and will get back to you soon”?
  • Should this always be active? Or just for the webknossos.org instance?

@hotzenklotz
Copy link
Member Author

Should the user maybe get a slightly different email along the lines of “we received the following feedback message and will get back to you soon”?

I don't think that it makes much of a difference. The email copy for the user serves primarily to give him some feedback that his request/question was entered into the system. It also nicely ties together the conversation, when we answer directly to that email.

Should this always be active? Or just for the webknossos.org instance?

Yes, I think it should be available for all instances. It does not hurt if we get questions from the open-source instances or dedicated hosted ones. If we get to too many questions (doubtful) then we can always be more selective with this feature.

Copy link
Member

@philippotto philippotto left a comment

Choose a reason for hiding this comment

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

this crashes when being logged out, so i couldn't test the actual UX yet 🙈

frontend/javascripts/admin/admin_rest_api.ts Outdated Show resolved Hide resolved
frontend/javascripts/oxalis/view/help_modal.tsx Outdated Show resolved Hide resolved
frontend/javascripts/navbar.tsx Outdated Show resolved Hide resolved
@hotzenklotz
Copy link
Member Author

@philippotto The logged-out crash should be fixed. Thanks for spotting that.

Comment on lines 18 to 19
if (!activeUser) return null;
if (activeUser && activeUser.novelUserExperienceInfos.hasDiscardedHelpButton) return null;
Copy link
Member

Choose a reason for hiding this comment

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

should logged-out users see the help button and be able to send emails? we won't know their email to reply though, right? if we support this somehow, the close-button should be hidden, though, since it doesn't do anything.

Copy link
Member Author

Choose a reason for hiding this comment

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

Logged out users should not see the help button:

  1. We don't have an email to respond to
  2. there is not much you can do in logged out state anyway. you likely be browsing the landing page
    2.1 alternatively, you can be logged out for viewing a public dataset/annotation. That is a read-only interaction anyway and would not expect someone to ask questions

@hotzenklotz hotzenklotz enabled auto-merge (squash) October 19, 2022 15:11
};

if (!activeUser) return null;
if (activeUser && activeUser.novelUserExperienceInfos.hasDiscardedHelpButton) return null;
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
if (activeUser && activeUser.novelUserExperienceInfos.hasDiscardedHelpButton) return null;
if (activeUser.novelUserExperienceInfos.hasDiscardedHelpButton) return null;

since you are already checking for !activeUser

Copy link
Member

@philippotto philippotto left a comment

Choose a reason for hiding this comment

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

works for me 👍 let's see how often this is used. on a big screen, the help button is rather low-key, but that's better than being too offensive, I guess.

@hotzenklotz hotzenklotz merged commit b8326a1 into master Oct 20, 2022
@hotzenklotz hotzenklotz deleted the help_button branch October 20, 2022 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Help button
3 participants