[`list-clouds`] Output contains extraneous information

Bug #1795996 reported by Peter Matulis
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Canonical Juju
Fix Released
Medium
Peter Matulis

Bug Description

In contrast to other commands, `list-clouds` contains CLI help type information and should just be removed:

Try 'list-regions <cloud>' to see available regions.
'show-cloud <cloud>' or 'regions --format yaml <cloud>' can be used to see region endpoints.
Update the known public clouds with 'update-clouds'.
'add-cloud' can add private or custom clouds / infrastructure built for the following provider types:
  - lxd, maas, manual, oci, openstack, oracle, vsphere

See below for a complete view:

http://paste.ubuntu.com/p/WhgV2v8wSH/

The text is also very unsightly. It can be improved but, as discussed with several developers today, it was decided that this text be removed. The CLI help should be reviewed in case the removed text can be recycled.

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

I think that this help needs to be re-formatted rather than removed.

We do have other command help texts that point to a related, relevant commands. So there is definitely a precedence.

It is certainly relevant to know how to find regions for a cloud. It is also relevant to know that the public clouds list may be changed and how to update your own copy both in terms of 'refresh' concept as well as an 'addition'.

tags: added: helptext usability
Changed in juju:
status: New → Triaged
importance: Undecided → Medium
Revision history for this message
Richard Harding (rharding) wrote :

I think the argument here is that this is perfect information for a --help output, but this is output during the normal course of using the command. I think it should be moved to the --help output and not be present in the normal use of the command.

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

Ah, yes! I agree that here, this information should be contained in help for the command and not necessarily as an output of running the command.

However, lately, there have also been a notion of providing user friendly information of the type (a) 'where to from here?' as well as (b) 'not seeing what you expected? try this'...

An example of (a) would be what we do with empty lists - when requesting a list of something and getting an empty result, we tend to make suggestions. Another, different aspect of this would be an output from 'add-user'.

An example of (b) would be something like 'juju controllers' with '-refresh' message when we suspect that the information provided could be outdated.

So, we certainly have precedence of being more verbose about anticipating user's next logical step and providing guidance in addition to just running commands. I do not think that we should always be sterile and clinical in our outputs, especially for the commands that may be involved in setting up a client, such as 'clouds' here.

Revision history for this message
Joseph Phillips (manadart) wrote :

Disregarding where this content should be presented, I think the use "Try <thing x>" is very passive - almost like we're assuming tribulation when using Juju.

Simple assertive statements like "Use x to do y" read cogent and direct.

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

I agree.

Changed in juju:
assignee: nobody → Peter Matulis (petermatulis)
Changed in juju:
status: Triaged → In Progress
Revision history for this message
Peter Matulis (petermatulis) wrote :

It was agreed in the end to just remove the text.

Relevant PR:

https://github.com/juju/juju/pull/9280

Changed in juju:
status: In Progress → Fix Committed
milestone: none → 2.5-beta1
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.