lxd icon indicating copy to clipboard operation
lxd copied to clipboard

docs: `lxc list` web-based documentation has broken/unreadable layout

Open rptb1 opened this issue 1 year ago • 2 comments

The web page at https://documentation.ubuntu.com/lxd/en/latest/reference/manpages/lxc/list/ has a broken layout compared to the output of lxc help list though they are clearly from the same source.

Web: Screenshot from 2024-11-05 07-25-46

Textual output of lxc help list:

  Pre-defined column shorthand chars:
    4 - IPv4 address
    6 - IPv6 address
    a - Architecture
    b - Storage pool
    c - Creation date
    d - Description
    D - disk usage
    e - Project name
    l - Last used date
    m - Memory usage
    M - Memory usage (%)
    n - Name
    N - Number of Processes
    p - PID of the instance's init process
    P - Profiles
    s - State
    S - Number of snapshots
    t - Type (persistent or ephemeral)
    u - CPU usage (in seconds)
    L - Location of the instance (e.g. its cluster member)
    f - Base Image Fingerprint (short)
    F - Base Image Fingerprint (long)

Reported from: https://documentation.ubuntu.com/lxd/en/latest/reference/manpages/lxc/list/

rptb1 avatar Nov 05 '24 07:11 rptb1

Heads up @mionaalex - the "Documentation" label was applied to this issue.

github-actions[bot] avatar Nov 05 '24 07:11 github-actions[bot]

@minaelee are you able to take a look at this one please?

tomponline avatar Apr 30 '25 08:04 tomponline

Hi @minaelee is this still on your radar? Thanks

tomponline avatar Sep 13 '25 18:09 tomponline

This is in the docs backlog (Jira ticket).

The man pages are converted from Go to Markdown. The origin uses single newlines, which are ignored in Markdown. Converting each single newline to a double newline in Markdown would cause the formatting in many other pages to break; using double newlines in Go would break the formatting in the CLI output. I will need to look further to resolve this.

minaelee avatar Sep 15 '25 12:09 minaelee