Commit Graph

19 Commits

Author SHA1 Message Date
948c24d8aa remove Jekyll tags from CLI reference
These Markdown files are now embedded in a YAML
file for templating in the documentation, and
these special markers are no longer needed.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 7e3169f26d4600691de9698598a2e5a064ea85eb
Component: engine
2017-03-02 02:14:15 +01:00
7196026b57 Standardized formatting of CLI reference commands
Command name should be a H1

Only Description, Examples, and Related Commands should be H2

Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands

Added some examples where relevant

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 52df69f00d966904ba230dc2e3a0646cc52b7688
Component: engine
2017-02-08 16:57:58 -08:00
062414bb0e fix frontmatter keywords value type (string, instead of []string) in /docs/reference
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
Upstream-commit: 248c699ec88bb249ce9fd03001d13f29ac0b4b99
Component: engine
2016-11-03 15:48:30 -07:00
b2f3f16f09 Sync docker/docker refs with files mistakenly edited in docker.github.io repo
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 3b36f02c03ec050aa46f9a01cd2d6c60ffd93652
Component: engine
2016-10-20 10:51:30 -07:00
74ef1fda6a Update the link for understand data volumes
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: b1c2d425e167e6f939a192c87a7a40f449f07e32
Component: engine
2016-10-20 01:25:59 +08:00
77c700603f Fix typs from go to Go
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: 7dad9d5ce45f25750f339642d3b84a81cc2ba98e
Component: engine
2016-10-18 19:40:16 +08:00
9fe833df60 Convert Markdown frontmatter to YAML
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: b30609446d212624e3d4ce814c70130b75c552a0
Component: engine
2016-10-14 15:44:55 -07:00
d634daae27 Updates on cli reference documentation
- Update ps with `--last` flag
- Update commands with current output
- Make sure hugo does not detect the wrong language
- Update usage for `tag` command to be more coherent with the other ones

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: f4cfc6b9830ed236eb588d6a4dddca7455145e70
Component: engine
2016-07-07 20:43:18 +02:00
939b820305 make cmd short short consistency and change docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 184afb92bf0bda1f47b5e1812ee1134328e272e2
Component: engine
2016-06-30 21:17:51 +08:00
ce19593c15 surfacing Learn by example topics to top level of Docker Engine docs
fixing links after moving surfacing tutorials

fixing more links for the newly located tutorials

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Upstream-commit: 8eca8089fa35f652060e86906166dabc42e556f8
Component: engine
2016-06-13 13:32:30 -07:00
ed92db4f93 Allow volume drivers to provide a Status field
The `Status` field is a `map[string]interface{}` which allows the driver to pass
back low-level details about the underlying volume.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Upstream-commit: 36a1c56cf555f8fe9ceabeebb8fc956e05863fc7
Component: engine
2016-04-15 10:56:38 -04:00
615c87e18e add a section to each volume page
Signed-off-by: ozlerhakan <hakan.ozler@kodcu.com>
Upstream-commit: 910ea8adf6c2c94fdb3748893e5b1e51a6b8c431
Component: engine
2016-02-18 21:52:15 +02:00
743bbc7202 remove =false from options that default to false in the docs
This re-aligns the docs with what the cmd line now does.

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: e6115a6c1c02768898b0a47e550e6c67b433c436
Component: engine
2015-12-23 07:11:35 -08:00
92d26f8f83 Fix a small typo in volume_inspect.md
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: a96be2930a64be88a5e8bf0e3b0283c657f73844
Component: engine
2015-11-18 16:02:24 +01:00
e4ab924436 Fixing wrong volume doc format
Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
Upstream-commit: a874ce08f3742d219f105a8b3d5cb7f37544824b
Component: engine
2015-11-09 02:17:50 -06:00
b51b5af287 Fix man and commandline docs
- missing help option in `docs/reference/commandline/*.md` (some files
  have it, the other I fixed didn't)
- missing `[OPTIONS]` in Usage description
- missing options
- formatting
- start/stop idempotence

Signed-off-by: Antonio Murdaca <amurdaca@redhat.com>
Upstream-commit: 14e8898648909379f37049828e103ba1c97f253b
Component: engine
2015-10-04 21:22:27 +02:00
fb110ef322 update docker volume man pages
- added --help option
- fixed several formatting problems

Also added --help to volume inspect reference page.

Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: 2724010364e6d7d316a244ae37850e8c91abb87c
Component: engine
2015-09-09 19:16:39 +02:00
c50d0a0555 Fix usage for docker volume inspect and docker volume rm
For both commands, volume is _not_ optional. Several volumes may
be specified.
Both commands now use the same name (VOLUME) for the command argument.

Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: 00eaa7e1f53d9100e95af80d8a05f8e77e380464
Component: engine
2015-09-08 09:14:57 -07:00
bfe1bbc7d2 Add volume API/CLI
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Upstream-commit: b3b7eb2723461b1eb4be692f4bced0ae8ea9cb58
Component: engine
2015-08-26 13:37:52 -04:00