Keeping action descriptions tight

[Mark Shuttleworth]

No, I'd like a single line of known max length, please.

The example of the proposal below is carefully constructed to look nice.
In reality, if it is a freeform text field, you will get a bizarre
amalgam of styles and formats.

Here's the guidance:

 * there should only be one piece of text (not summary + description,
just description)
 * we will display up to 65 letters of the first line

We should also require the action name to be less than a specific number
of letters, and reject uploads that break that rule.

Thanks,
Mark


On 26/08/16 11:21, Rye Terrell wrote:
> Little late to the party, but I'd like to throw this alternate format
> out there for consideration:
>
> 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 
>
> If it's acceptable, we might not need to worry so much about the
> length of descriptions. I've attached a small demo so you can resize
> your terminal and get a feel for it.
>
> Cheers,
> Rye
>
> On Tue, Aug 23, 2016 at 9:19 AM, Charles Butler
> <charles.butler at canonical.com <mailto:charles.butler at canonical.com>>
> wrote:
>
>     I took this feedback and updated the PR upstream. The new action
>     descriptions will go out with the next publication of the charm.
>
>     https://github.com/kubernetes/kubernetes/pull/31202
>     <https://github.com/kubernetes/kubernetes/pull/31202>
>
>     If there are any further feedback items about the action
>     descriptions it would be great to capture them on the bug so we
>     can settle on crisp messaging to the end user what exactly is
>     happening.
>
>     I moved the longer descriptions to the README, so the full text
>     wasn't lost and it's very clear to the end user what the actions
>     are doing on their behalf.
>
>     All the best,
>
>     Charles
>
>
>     On Tue, Aug 23, 2016 at 7:03 AM Mark Shuttleworth <mark at ubuntu.com
>     <mailto: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 <mailto:Juju at lists.ubuntu.com>
>         Modify settings or unsubscribe at:
>         https://lists.ubuntu.com/mailman/listinfo/juju
>         <https://lists.ubuntu.com/mailman/listinfo/juju>
>
>     -- 
>     Juju Charmer
>     Canonical Group Ltd.
>     Ubuntu - Linux for human beings | www.ubuntu.com
>     <http://www.ubuntu.com>
>     Juju - The fastest way to model your service | www.jujucharms.com
>     <http://www.jujucharms.com>
>
>     --
>     Juju mailing list
>     Juju at lists.ubuntu.com <mailto:Juju at lists.ubuntu.com>
>     Modify settings or unsubscribe at:
>     https://lists.ubuntu.com/mailman/listinfo/juju
>     <https://lists.ubuntu.com/mailman/listinfo/juju>
>
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju/attachments/20160826/beffa3c2/attachment.html>