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
e1a6c1f1b2 Update the field 'CONTAINER ID' for docker ps
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: b3faa7755a48eb09ba977502fd40e37ab98e1cf8
Component: engine
2016-12-29 02:00:31 +08:00
3f00f70bbf field NAMES ommitted after docker ps in commit.md
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
Upstream-commit: f34ccd70c8c55946fe9d3b83b44bdac770858176
Component: engine
2016-12-20 20:34:09 +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
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
d83ba877bb Document valid chars in image name and tag
- Add link to valid image name and tag formats in referenced files
- Per review comments, updated docs to remove reference to `USERNAME` and
`REGISTRYHOST`.
- Per review comment, removed links from man page.
- Per review comment, added and updated examples on `docker tag`

Signed-off-by: Subhajit Ghosh <isubuz.g@gmail.com>
Upstream-commit: ea98cf74aad3c2633268d5a0b8a2f80b331ddc0b
Component: engine
2016-05-21 19:49:19 +01:00
6f4e1021b0 Fix some flaws in docs
Signed-off-by: Jian Zhang <zhangjian.fnst@cn.fujitsu.com>
Upstream-commit: cdc7f26715fbf0779a5283354048caf9faa1ec4a
Component: engine
2016-02-19 09:27:03 +08:00
642e9a30eb Correct old virtual size
In new content addressable model, image no longer
have virtual size column, it is now 'size'. So we
need to update related docs about them.

Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
Upstream-commit: 1ab7d76f30f3cf693c986eb827ad49a6554d806d
Component: engine
2016-02-02 12:28:33 +00:00
45878e7bdb Fix commit wrong repository example
The old name is invalid in new repository name spec.
So we need to fix them.

Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
Upstream-commit: 3c8042a0cb2253be37303e6d646e96d87cefe0fc
Component: engine
2016-01-20 10:25:41 +00: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
88979b7a5e Add CMD and EXPOSE instruction example
Signed-off-by: Mihuleacc Sergiu <mihuleac.sergiu@gmail.com>
Upstream-commit: fad2cc6a18f28658b99be8f2951290b03ccbabf0
Component: engine
2015-10-12 17:30:47 +03:00
92bcbdcb5f Fixing issues in command ordering. Adding index.md
Adjust bullets
Entering Seb's comments

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: b44ef2b306c56dad16500c3738b0f29ec0f34635
Component: engine
2015-10-08 09:28:46 -07: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
5b5bcdcb21 Align 'docker commit' docs with the code
It was missing some variants and 'maintainer' isn't actually supported.
Also sorted the list of allowed cmds in the code just to make it easier
to diff with the docs.

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 0bf0e5a6efb6d4718f18db11084295aaba2062e3
Component: engine
2015-07-09 13:17:47 -07:00
d49aa7e5dc Update docker commit man page re: volumes
Update the man page for 'docker commit' to make explicit the fact that
'commit' does not save data in volumes.

Addresses comments in #7583

Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
Upstream-commit: a9747895375a27e0f4d46d9cf8f501815e5b2642
Component: engine
2015-07-06 10:16:21 -04:00
c4d8b40978 Splitting out the cli command into parts.
Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 561bfb268de3c674b04d48895b7e46ae890ef795
Component: engine
2015-06-25 12:02:41 -07:00