Keeping action descriptions tight

[Rick Harding]

I'm +1 on an enforced limit as long as we get the charm author's somewhere
for more information. Actions can be great solutions to complex problems
and need some explanation of what they will and won't do. Truncating is the
best immediate solution that comes to mind while we work out if we need a
summary/description style, or readme, or something else.

On Tue, Aug 23, 2016 at 8:50 AM Adam Collard <adam.collard at canonical.com>
wrote:

> Instead of Juju automatically truncating it, I think it'd be better to
> have the charm author explicitly provide a short description which is
> verified at charm-proof time to be within the limit.
>
> On Tue, 23 Aug 2016 at 13:33 Rick Harding <rick.harding at canonical.com>
> wrote:
>
>> I think we should truncate it to a reasonable length and folks will be
>> able to get at the full information once we fix the bug about a missing
>> show-action command. [1]
>>
>> It is interesting in that there might be a need to add some basic
>> 'readme' style support to actions as they grow in complexity to help users
>> understand how to use them properly and what they're doing. Complex
>> interactions such as OpenStack service upgrade steps come to mind. I wonder
>> if there was a more long winded info section if that would also encourage
>> keeping the description length down.
>>
>>
>> 1: https://bugs.launchpad.net/juju/+bug/1596906
>>
>> On Tue, Aug 23, 2016 at 8:03 AM Mark Shuttleworth <mark at ubuntu.com>
>> wrote:
>>
>>>
>>> Working with the Kubernetes charms today (thanks Chuck & friends) I saw
>>> this:
>>>
>>>
>>> $ juju list-actions kubernetes
>>> ACTION             DESCRIPTION
>>> clean-containers   Garbage collect non-running containers
>>> clean-images       Garbage collect non-running images
>>> guestbook-example  Launch the guestbook example in your k8s cluster
>>> microbot           Launch microbot containers
>>> pause              Cordon the unit, pausing all future workload
>>> scheduling on this unit,
>>> and drains active workloads
>>> resume  UnCordon the unit, enabling workload scheduling. Workloads
>>> will automatically balance into the unit
>>>
>>>
>>> The fact that we have a bunch of useful operational actions crowdsources
>>> for Kubernetes is brilliant, but the way that list gets wonky towards
>>> the end with overrunning text lines is a niggle. Should we just
>>> hard-truncate such descriptions in a single line, so reinforce the
>>> social contract around keeping those summaries one-line friendly?
>>>
>>>
>>> Mark
>>>
>>>
>>>
>>> --
>>> Juju mailing list
>>> Juju at lists.ubuntu.com
>>> Modify settings or unsubscribe at:
>>> https://lists.ubuntu.com/mailman/listinfo/juju
>>>
>> --
>> Juju mailing list
>> Juju at lists.ubuntu.com
>> Modify settings or unsubscribe at:
>> https://lists.ubuntu.com/mailman/listinfo/juju
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju/attachments/20160823/03e3d403/attachment.html>