On Tue, Aug 23, 2016 at 8:33 AM Rick Harding <[email protected]> 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] > Truncation is a bit annoying, I "like" (it actually annoyed me quite a bit at first) that snaps enforce 72 characters for the summary key. This is something we can definitely do with things like `charm proof` for actions.yaml > > 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. > I wonder if we haven't made a slight mistake in choosing description as the key for actions. In the charm metadata we use `summary` and `description` where the former is < 80 characters and description is long free form. Potentially, adding a summary key for actions where that's displayed in the list and enforced at a reasonable length. Description could then be used and continue being that longer form readme style? This would also be helpful when displaying actions in the store and juju gui - which we do neither of at the moment. > 1: https://bugs.launchpad.net/juju/+bug/1596906 > > On Tue, Aug 23, 2016 at 8:03 AM Mark Shuttleworth <[email protected]> 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 >> [email protected] >> Modify settings or unsubscribe at: >> https://lists.ubuntu.com/mailman/listinfo/juju >> > -- > Juju mailing list > [email protected] > Modify settings or unsubscribe at: > https://lists.ubuntu.com/mailman/listinfo/juju >
-- Juju mailing list [email protected] Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/juju
