Container documentation
Hallo, One small question strictly not related to podman: are there any means to bundle container-related documentation to container itself, similar to perl's embedded POD) and to query it in some generic way? (say like 'podman docs <container name>')? Best regards, -- \ / | | (OvO) | Михаил Иванов | (^^^) | | \^/ | E-mail: ivans@isle.spb.ru | ^ ^ | |
On 10/12/21 5:56 AM, Michael Ivanov wrote:
Hallo,
One small question strictly not related to podman: are there any means to bundle container-related documentation to container itself, similar to perl's embedded POD) and to query it in some generic way? (say like 'podman docs <container name>')?
Hey, Currently none that I'm aware of, but, man, that's a really cool idea! There are a few places where metadata of various kinds could be used to point at external docs, but nothing I'm aware of that's suitable for storing even a few screen-fulls. It may be a long road, but getting support for this into the OCI spec. would be ideal. That way all container tooling can benefit. https://github.com/opencontainers/image-spec#contributing You're welcome to propose this yourself, and there are also folks here that may be willing to shepherd the effort. Personally, I think it's a brilliant idea. -- Chris Evich (he/him), RHCA III Senior Quality Assurance Engineer My personal robot overlord told me to include this signature line.
participants (2)
-
Chris Evich -
Michael Ivanov