linuxcontainers.org icon indicating copy to clipboard operation
linuxcontainers.org copied to clipboard

[Feature Request] Add manpages for LXD

Open toby63 opened this issue 3 years ago • 4 comments

In recent time we had some discussions in the forums, where users would like to have more information regarding the available commands and details on them (flags etc.).

I think it would be useful to add manpages to the website for a better workflow while reading the Advanced Guide for example. We could link to the manpages to give users more information on available flags and options for commands. This way we don't have to include all options in the Guides themselves, because:

  1. The flags etc. might change in the future.
  2. We could keep the guides short.

toby63 avatar Jan 28 '21 19:01 toby63

We have automated scripts that handle that for LXC, the rendering on the website isn't the prettiest (man2html isn't all that great) but it's good enough.

For LXD, I just pushed https://github.com/lxc/lxd/pull/8397 which then lets you do lxc manpage --format=md /tmp/some-dir

stgraber avatar Jan 28 '21 21:01 stgraber

For clarification: Do you plan to implement automated scripts for LXD too? Or should I run the command and add the manpages manually? Or was this just intended for personal use?

toby63 avatar Jan 29 '21 15:01 toby63

I'll have this command run automatically on the server at some point, then we can add it to the website.

stgraber avatar Jan 29 '21 15:01 stgraber

Ok, I will probably add links to the existing pages (Advanced Guide etc.), once it's ready.

the rendering on the website isn't the prettiest (man2html isn't all that great) but it's good enough.

I think it looks quite good.

toby63 avatar Jan 29 '21 17:01 toby63