No help Topics in 2.0

Nate Finch nate.finch at canonical.com
Wed Jul 27 03:08:36 UTC 2016


Juju 1.x had a ton of help in the CLI, right at your fingertips:

$ juju1 help topics
azure-provider      How to configure a Windows Azure provider
basics              Basic commands
commands            Basic help for all commands
constraints         How to use commands with constraints
ec2-provider        How to configure an Amazon EC2 provider
global-options      Options common to all commands
glossary            Glossary of terms
hpcloud-provider    How to configure an HP Cloud provider
juju                What is Juju?
juju-systems        About Juju Environment Systems (JES)
local-provider      How to configure a local (LXC) provider
logging             How Juju handles logging
maas-provider       How to configure a MAAS provider
openstack-provider  How to configure an OpenStack provider
placement           How to use placement directives
plugins             Show Juju plugins
spaces              How to configure more complex networks using spaces
topics              Topic list
users               About users in Juju

Almost all of this has been removed in 2.0:

$ juju help topics
basics          Basic Help Summary
commands        Basic help for all commands
global-options  Options common to all commands
topics          Topic list

There are a lot of parts of the CLI that *need* that extra level of
documentation.  I'm all for dropping a link to the website at the bottom of
some help docs for further info, but dropping the help entirely seems like
a mistake.  Some things like constraints and placement are used in multiple
commands, but there's no way to know from the CLI how to entire valid
values for them.  Things like the providers are not explained anywhere in
the CLI now, as far  as I can tell.

The plaintext docs are the easiest thing for us to update and maintain...
they live right in our own repo and let us update them whenever the code
updates, and they're the easiest thing for users to get to... let's not
drop that on the floor.

-Nate
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju-dev/attachments/20160727/943578a3/attachment.html>


More information about the Juju-dev mailing list