Commit Graph

9 Commits (ab09846df70df822fd32b9d0c715dc0605344618)

Author SHA1 Message Date
Sebastiaan van Stijn cd3a9ad38d
docs: address some review comments from the docs repository
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
4 years ago
Sebastiaan van Stijn 44ddc5a02b
remove trailing whitespace in command descriptions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
4 years ago
Tonis Tiigi 4047bccf6c
docs: add external docs links support
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
4 years ago
Tonis Tiigi c46407b2d3
docs: reference docs updates
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
4 years ago
Sebastiaan van Stijn 17d4106e1b
docs: fix markdown formatting and highlighting
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
4 years ago
Sebastiaan van Stijn 442d38080e
docs: use "examples" section, and rephrase headings
Put the flag descriptions/examples under an "examples"
section (used at docs.docker.com), and rephrase the
headings to be more consistent with other pages in the
docker documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
4 years ago
Sebastiaan van Stijn 87ec3af5bb
docs: add stubs for all commands
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
4 years ago
Sebastiaan van Stijn 1a8af33ff6
docs: standardize format for usage
Use the usage output of `--help` for each subcommand, to make
sure all flags/options are included on the page, and to make
it easier to keep docs in sync.

Note that the usage output is only used when reading these
docs on GitHub; docs.docker.com only consumes the "description"
and "example" sections (when present), and generates flag information
and usage output from source

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
4 years ago
Sebastiaan van Stijn ff749d8863
docs: split reference docs to separate files
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
4 years ago