`juju info` doesn't put summary next to description

[John A Meinel]

We were discussing how documentation gets presented. And one of the concepts was around whether summary and description are conflicting.
The suggestion was that we should always put summary just before description, so people get used to the idea of not repeating yourself.

Right now our output is not sorted in an obvious fashion, and we should be putting those things together.

eg:
$ juju info mattermost-k8s
name: mattermost-k8s
charm-id: TUYEUsuX3AD0PvoF7foTGau2iIcXoyhr
summary: Mattermost is a flexible, open source messaging platform that enables secure
  team collaboration.
publisher: Paul Collins
supports: kubernetes
subordinate: false
store-url: https://charmhub.io/mattermost-k8s
description: |
  Mattermost is a flexible, open source messaging platform that enables
  secure team collaboration.
  https://mattermost.com
relations:
  provides: {}
  requires:
    db: pgsql
channels: |
  latest/stable: 20 2021-08-09 (20) 926kB
  latest/candidate: ↑
  latest/beta: ↑
  latest/edge: 18 2021-06-14 (18) 931kB

I think this might be better as:

$ juju info mattermost-k8s
name: mattermost-k8s
store-url: https://charmhub.io/mattermost-k8s
publisher: Paul Collins
summary: Mattermost is a flexible, open source messaging platform that enables secure
  team collaboration.
description: |
  Mattermost is a flexible, open source messaging platform that enables
  secure team collaboration.
  https://mattermost.com
supports: kubernetes
subordinate: false
charm-id: TUYEUsuX3AD0PvoF7foTGau2iIcXoyhr
relations:
  provides: {}
  requires:
    db: pgsql
channels: |
  latest/stable: 20 2021-08-09 (20) 926kB
  latest/candidate: ↑
  latest/beta: ↑
  latest/edge: 18 2021-06-14 (18) 931kB

This can still be a bit of bike shedding, but we should have some consistency here.

[Daniele Procida (danieleprocida)]

It doesn't look like bike-shedding at all. I think you've done a lot of the right things there. I'd even drop the URL further down, on the basis that anything the user needs (such as metadata), they will look for, but anything we want them to read should be right up front.

[Ben Hoyt (benhoyt)]

https://github.com/juju/juju/pull/14552