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

Improve UX of the output #463

Open
5 tasks
3rd-Eden opened this issue Aug 9, 2013 · 1 comment
Open
5 tasks

Improve UX of the output #463

3rd-Eden opened this issue Aug 9, 2013 · 1 comment

Comments

@3rd-Eden
Copy link
Member

3rd-Eden commented Aug 9, 2013

It's common that people come in to the #nodejitsu chatroom with questions about deployment failures. This should not be necessary if our output was straight forward and provided people with steps to resolve this issue.

For example, if you want to deploy and don't have a subscription you get an error error: Error: No active subscriptions available. with a huge stack trace. As a customer of Nodejitsu, this stack trace is completely pointless and doesn't provide any addition details on how to resolve the issue. It just makes people feel that something on our cloud broke down instead of realising that it's an error that they have to resolve them self.

For all these errors it would be much more productive for us as well as for our customers to be presented with an action list of steps they can follow to resolve the issue.

For the error: Error: No active subscriptions available. error a following list could be presented:


No active subscriptions available.

You cannot deploy to Nodejitsu if you don't have an active subscription. You can activate a subscription at webops.nodejitsu.com

  1. Go to https://webops.nodejitsu.com and login with your Nodejitsu credentials
  2. Fill in your billing information or go to the Plans tab
  3. Activate a plan
  4. You should be able to deploy again

In addition to that, we output way to much garbage information, it might be useful to us such as the following output:

info:    Executing command cloud
info:    Fetching app <appname>

But from a user perspective I honestly couldn't care less about this. I just want to know that the command is being executed with maybe a spinner for progress indication and a simple success message.

I feel there's a lot of work we can do to make jitsu much more user friendly without instructing everybody to drop in #nodejitsu with their error output while most of the errors aren't even "real" errors that "we" need to resolve.

My suggestions so far:

  • Remove the info: Error: prefixes, it only adds noise
  • Provide the user with steps to resolve the errors.
  • Drop the stack traces from the output.
  • Error messages should be done in red to make them stand out further.
  • Save a debug output to jitsuerror.log and automatically upload it to gist.github.com so people can just share the link
@Swaagie
Copy link
Member

Swaagie commented Aug 9, 2013

  • add line-breaks at critical places, e.g. between jitsu version output and the actual output

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

No branches or pull requests

2 participants