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

Make error messages friendlier #5123

Closed
benjaoming opened this Issue May 25, 2016 · 6 comments

Comments

Projects
None yet
3 participants
@benjaoming
Member

benjaoming commented May 25, 2016

Summary

In #4875 @j-schwartz noted this important issue in KA Lite:

From the perspective of a first time computer user, or at least first time KA-lite user, you have 90% fear of breaking something and 10% excitement.

There are lots of kids I have seen, who if they saw that sorry, something has gone wrong message, after first watching a video, will immediately close the browser and walk away for fear they have done something wrong.

The investment in computers / ka-lite / time on hardware is massive relative to school budgets, and the fear of breaking something is one of the primary obstacles I see us trying to overcome to increase adoption.

Solving this issue

There are error messages in many places, both Javascript and Python. But we should especially target those that can face students.

This happens when error handling Javascript exceptions, missing content, broken exercises.

But we still cannot drop exception information. So make sure this goes in the Javascript console if it's a JS error or in the application log if it's a Python error.

Example

image

Message should be displayed in a more graphical and with a friendlier text, here's a suggestion:

Hey there! Unfortunately a technical error has occured which is not your fault! 
This exercise had problems displaying itself. But don't worry, there are over
25,000 exercises, and a dedicated team is always looking to make each and
every one of them function. Let's hope in a future update, that this exercise will
be fixed.

Branch or installer method

  • Branch: develop

Real-life consequences (anything community should be aware, for instance how it affects your deployment)

Can have very severe consequences even if it's an anticipated error.

@j-schwartz

This comment has been minimized.

Show comment
Hide comment
@j-schwartz

j-schwartz May 25, 2016

This is great. Thanks guys! I might add somewhere in there, "this is not
your fault"

On Wed, May 25, 2016 at 1:34 AM Benjamin Bach notifications@github.com
wrote:

Summary

In #4875 #4875
@j-schwartz https://github.com/j-schwartz noted this important issue in
KA Lite:

From the perspective of a first time computer user, or at least first time
KA-lite user, you have 90% fear of breaking something and 10% excitement.

There are lots of kids I have seen, who if they saw that sorry, something
has gone wrong message, after first watching a video, will immediately
close the browser and walk away for fear they have done something wrong.

The investment in computers / ka-lite / time on hardware is massive
relative to school budgets, and the fear of breaking something is one of
the primary obstacles I see us trying to overcome to increase adoption.

Solving this issue

There are error messages in many places, both Javascript and Python. But
we should especially target those that can face students.

This happens when error handling Javascript exceptions, missing content,
broken exercises.

But we still cannot drop exception information. So make sure this goes in
the Javascript console if it's a JS error or in the application log if it's
a Python error.
Example

[image: image]
https://cloud.githubusercontent.com/assets/9270388/15523994/6c038a10-21d3-11e6-87d0-bf17f7088ba3.png

Message should be displayed in a more graphical and with a friendlier
text, here's a suggestion:

Hey there! This exercise had problems displaying itself. But don't worry, there are over 25,000 exercises, and a dedicated team is always looking to make each and every one of them function. Let's hope in a future update, that this exercise will be fixed.

Branch or installer method

  • Branch: develop

Real-life consequences (anything community should be aware, for instance
how it affects your deployment)

Can have very severe consequences even if it's an anticipated error.


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#5123

j-schwartz commented May 25, 2016

This is great. Thanks guys! I might add somewhere in there, "this is not
your fault"

On Wed, May 25, 2016 at 1:34 AM Benjamin Bach notifications@github.com
wrote:

Summary

In #4875 #4875
@j-schwartz https://github.com/j-schwartz noted this important issue in
KA Lite:

From the perspective of a first time computer user, or at least first time
KA-lite user, you have 90% fear of breaking something and 10% excitement.

There are lots of kids I have seen, who if they saw that sorry, something
has gone wrong message, after first watching a video, will immediately
close the browser and walk away for fear they have done something wrong.

The investment in computers / ka-lite / time on hardware is massive
relative to school budgets, and the fear of breaking something is one of
the primary obstacles I see us trying to overcome to increase adoption.

Solving this issue

There are error messages in many places, both Javascript and Python. But
we should especially target those that can face students.

This happens when error handling Javascript exceptions, missing content,
broken exercises.

But we still cannot drop exception information. So make sure this goes in
the Javascript console if it's a JS error or in the application log if it's
a Python error.
Example

[image: image]
https://cloud.githubusercontent.com/assets/9270388/15523994/6c038a10-21d3-11e6-87d0-bf17f7088ba3.png

Message should be displayed in a more graphical and with a friendlier
text, here's a suggestion:

Hey there! This exercise had problems displaying itself. But don't worry, there are over 25,000 exercises, and a dedicated team is always looking to make each and every one of them function. Let's hope in a future update, that this exercise will be fixed.

Branch or installer method

  • Branch: develop

Real-life consequences (anything community should be aware, for instance
how it affects your deployment)

Can have very severe consequences even if it's an anticipated error.


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#5123

@benjaoming

This comment has been minimized.

Show comment
Hide comment
@benjaoming

benjaoming May 25, 2016

Member

Added that in the example, once someone starts working on this, I trust that they will also work on the contents of the error messages themselves!

Member

benjaoming commented May 25, 2016

Added that in the example, once someone starts working on this, I trust that they will also work on the contents of the error messages themselves!

@radinamatic

This comment has been minimized.

Show comment
Hide comment
@radinamatic

radinamatic May 26, 2016

Contributor

Very good idea, I'm proposing a slightly more simple phrasing:

Hey, the error you are seeing **is not your fault**! 

This exercise may have a technical problem, and we will work to have it corrected soon.

Please don't worry, and select another from 25,000 exercises in here to continue learning!

Since we are aiming this message for the young learners and our content is crowd-translated, let's make the English original as simple as possible 😉

** Ideally, the is not your fault would be styled differently.

Contributor

radinamatic commented May 26, 2016

Very good idea, I'm proposing a slightly more simple phrasing:

Hey, the error you are seeing **is not your fault**! 

This exercise may have a technical problem, and we will work to have it corrected soon.

Please don't worry, and select another from 25,000 exercises in here to continue learning!

Since we are aiming this message for the young learners and our content is crowd-translated, let's make the English original as simple as possible 😉

** Ideally, the is not your fault would be styled differently.

@benjaoming benjaoming closed this May 27, 2016

@benjaoming benjaoming reopened this May 27, 2016

@benjaoming

This comment has been minimized.

Show comment
Hide comment
@benjaoming

benjaoming May 27, 2016

Member

Well done, Ben :D

Member

benjaoming commented May 27, 2016

Well done, Ben :D

@benjaoming

This comment has been minimized.

Show comment
Hide comment
@benjaoming

benjaoming Dec 17, 2016

Member

Alright, this is not going any further until we have tried and tested the current errors in the wild. They trigger on status 500 from API endpoints.

Member

benjaoming commented Dec 17, 2016

Alright, this is not going any further until we have tried and tested the current errors in the wild. They trigger on status 500 from API endpoints.

@benjaoming benjaoming closed this Dec 17, 2016

@radinamatic

This comment has been minimized.

Show comment
Hide comment
@radinamatic

radinamatic Dec 19, 2016

Contributor

Yes, ideally, this would only appear on exercise pages, but I may have seen it on Manage > Videos download page... 😛

Contributor

radinamatic commented Dec 19, 2016

Yes, ideally, this would only appear on exercise pages, but I may have seen it on Manage > Videos download page... 😛

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment