Skip to content

Docs: --mount should have a dedicated section describing each type #25888

Open
@fice-t

Description

@fice-t

The current --mount documentation skips straight from the brief statement overview for --mount itself and the listing of all supported types straight into the description for the options for each type (i.e. no description for the types themselves).

It would be beneficial to have a section that describes the function of each individual mount type. Visually, my request is:

--mount=type=TYPE,TYPE-SPECIFIC-OPTION[,…]

Attach a filesystem mount to the container.

Current supported mount TYPEs are artifact, bind, devpts, glob, image, ramfs, tmpfs and volume.

<PARAGRAPH(S) DESCRIBING WHAT EACH TYPE DOES HERE>

Options common to all mount types:

<...>

For reference, here is the Docker section that provides an overview for each of their supported mount types.

On top of general overviews of each type, it would be nice to have example use cases for each (i.e. "When to use TYPE mount"). Docker includes such sections for both its volume and bind mount options.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Good First IssueThis issue would be a good issue for a first time contributor to undertake.documentationIssue or fix is in project documentationstale-issuetriagedIssue has been triaged

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions