container-storage-setup icon indicating copy to clipboard operation
container-storage-setup copied to clipboard

consider a manual via mkdocs

Open cgwalters opened this issue 9 years ago • 3 comments

I recently converted ostree (and rpm-ostree) to have mkdocs manuals. I think it's clear we should have some sort of larger documentation where we can cover storage design and the high level in a fashion that's not easy to do in a man page.

We can have a whole section on e.g. the background behind overlayfs.

This would duplicate the man page a little bit - but the man page I think should discuss the details of config options, whereas the manual would be more a "what is this anyways" thing.

cgwalters avatar Mar 15 '16 19:03 cgwalters

sounds like a good idea.

rhvgoyal avatar Mar 15 '16 19:03 rhvgoyal

Mmm...actually https://docs.docker.com/engine/userguide/storagedriver/ has improved since last I looked. Maybe we should just link to/contribute to that for most of this. There's still the host portion (including growing the root vg), but perhaps we can just include that in the man page.

cgwalters avatar Mar 15 '16 19:03 cgwalters

We should do that for generic description of different backends. But that documentation does not cover docker-storage-setup details. So if there is any information we want to detail which is specific to docker-storage-setup, should go here or in man page

rhvgoyal avatar Mar 15 '16 19:03 rhvgoyal