Juju 2 welcome message is confusing and incorrect

Bug #1634405 reported by Nicholas Skaggs
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Canonical Juju
Fix Released
Medium
Anastasia

Bug Description

The message when running juju 2 for the first time gives help about how to get juju-1 back. However, this information is very confusing as written, and for trusty users (who are the most likely to see it / have it affect them) it is wrong.

"Welcome to Juju 2.0.0. If you meant to use Juju 1.x you can continue using it
    with the command juju-1 e.g. 'juju-1 switch'.
    See https://jujucharms.com/docs/stable/introducing-2 for more details."

Saying juju-1 switch is confusing. Users (and me!) think it's a command to run (see bug 1633542). What is really being conveyed is that there is a link to the juju-1 binary by running juju-1. For trusty, this is not true. We should tweak the message to be clear, and drop the confusing juju-1 switch command which is implying something akin to 'run this to get juju 1.x back', rather than the intended 'use juju-1 to get /usr/bin/juju-1 which is the juju-1 binary'. For trusty users, update-alternatives should be used. On xenial, juju-1-default package install can be used. You can also call it expliclity on xenial/yakkety as noted. It may be best to drop this confusing verbiage altogether and point at a clear and concise docs page which can detail these differences.

Changed in juju:
status: New → Triaged
importance: Undecided → Medium
tags: added: helpdocs usability
Changed in juju:
milestone: none → 2.0.1
Changed in juju:
assignee: nobody → Anastasia (anastasia-macmood)
status: Triaged → In Progress
Revision history for this message
Anastasia (anastasia-macmood) wrote :

Doc issue to create a manual page: https://github.com/juju/docs/issues/1487

Once this page exists, we should link to it in the welcome message. Meanwhile, I'll propose prose.

Revision history for this message
Anastasia (anastasia-macmood) wrote :
Changed in juju:
status: In Progress → Fix Committed
Revision history for this message
Nick Veitch (evilnick) wrote :

I see this has already been committed - it would have been useful to use a different command as an example.

Also, the information supplied is only for Ubuntu users. What information is available to users on other versions of Linux, or Windows / Mac?

Revision history for this message
Nicholas Skaggs (nskaggs) wrote :

I agree, and commented the example should use the bootstrap command, not the switch command. Please update again if you don't mind :-)

However, given that the help text will get long and is impossible to update without a release, I don't think the juju cli help text should contain a bunch of information. The help page it points to however should detail windows, centos and mac as well as ubuntu, and can cover things in detail in a simple way. Perhaps you've put too much in the help cli already (we can't remove bad information once we've released a version of juju). Perhaps we should remove the example completely.

Revision history for this message
Anastasia (anastasia-macmood) wrote :

I agree and will propose a PR that provides bootstrap command as an example as per your suggestion with just a link to the docs as /introducing-2 manual page will be updated \o/

Changed in juju:
status: Fix Committed → In Progress
Revision history for this message
Anastasia (anastasia-macmood) wrote :

PR with "bootstrap" as an example and link to manual "co-exist" page describing how to install Juju 1 on different systems: https://github.com/juju/juju/pull/6489

Changed in juju:
status: In Progress → Fix Committed
Curtis Hovey (sinzui)
Changed in juju:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.