Request to add hanging indents to the output of juju actions
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Canonical Juju |
Triaged
|
Wishlist
|
Unassigned |
Bug Description
This is a wishlist item to improve the UX when using the `juju actions` command.
It would be valuable to add a hanging indent to multi-line action descriptions in the output of `juju actions`. It is not often that action descriptions require multiple lines, but things can become hard to read when they do. In such cases, as simple hanging indent on each item would increase readability and promote productivity.
Consider the following example:
$ juju actions postgresql
Action Description
maintenance-
maintenance-
replication-pause Pause replication replay on a hot standby unit.
replication-resume Resume replication replay on a hot standby unit.
switchover Promote a specific unit to master. Must be run on the leader unit.
wal-e-backup Run a wal-e backup to cloud storage now. Requires WAL shipping to be enabled with wal-e. Action terminates when the backup is complete.
wal-e-list-backups List backups available for PITR and their metadata.
wal-e-restore PITR database recovery from configured wal-e store. THIS WILL DESTROY YOUR EXISTING DATA. Most of these options correspond to PostgreSQL recovery target settings, documented at http://
Compare that to the same example, with a hanging indent:
$ juju actions postgresql
Action Description
maintenance-
charm will make no changes to the deployment. This action must be run on the Juju leader. It is your
responsibility to ensure that any manual maintenance work you perform will not confuse the charm and it
will regain control once maintenance mode is ended. Turning off mainenance mode after significant
changes, such as a manual failover, can result in catastrophic dataloss. It is also important to not
instruct Juju to make changes during maintenance mode, such as adding storage to units or upgrading the
charm, as the charm will not react to these changes and the operations can also result in catestrophic
dataloss when required preamble steps are not performed.
maintenance-
replication-pause Pause replication replay on a hot standby unit.
replication-resume Resume replication replay on a hot standby unit.
switchover Promote a specific unit to master. Must be run on the leader unit.
wal-e-backup Run a wal-e backup to cloud storage now. Requires WAL shipping to be enabled with wal-e. Action terminates when the backup is complete.
wal-e-list-backups List backups available for PITR and their metadata.
wal-e-restore PITR database recovery from configured wal-e store. THIS WILL DESTROY YOUR
EXISTING DATA. Most of these options correspond to PostgreSQL recovery target settings, documented at
http://
In the later example, is it much easier to quickly parse the names of all actions, which is a very common user operation.
Changed in juju: | |
importance: | Undecided → Wishlist |
status: | New → Triaged |