Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[1.12.x] docs cherry picks #29332

Merged
merged 25 commits into from
Dec 13, 2016
Merged

[1.12.x] docs cherry picks #29332

merged 25 commits into from
Dec 13, 2016

Conversation

thaJeztah
Copy link
Member

thaJeztah and others added 25 commits December 12, 2016 18:48
@thaJeztah
docs: add missing IPAM options to API docs
5dab892 
Commit dd28ded
brought in new networking features and API, but
did not document the available IPAM options.

This adds a description of those options.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit d69fce7)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@yongtang @thaJeztah
Update docs for node filter of docker service ps
3707a30 
As is specified in 26964, it is possible to specify
a filter based on the node name or node ID.

This fix updates the related docs for that.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
(cherry picked from commit c326e0a)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@milindchawre @thaJeztah
Fixes moby#27095 : Removing registrytoken field from doc as it is dep…
0735155 
…recated by identitytoken field

Signed-off-by: milindchawre <milindchawre@gmail.com>
(cherry picked from commit 72dd684)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@tealtail @thaJeztah
add documentation for docker stack ps
39466e3 
also updates related stack docs and removes stack_tasks.md

Signed-off-by: Alicia Lauerman <allydevour@me.com>
(cherry picked from commit 970ab9a)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Improve example for env vars in API docs
6d972ff 
This was added in e41de3e,
but can be a bit confusing due to the "outer" brackets
being for JSON, and the "inner" brackets to indicate
optional values.

During review of that change, this alternative
format was suggested.

Updating the example to use the format that was discussed
during review :)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 441c941)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Add KernelMemory to API changelog
554400b 
Commit 9bd8a9b
added KernelMemory to the API, but forgot
to include this in the API changelog.

This adds the missing entry in the API
changelog.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit f988a9c)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Improve API format examples
06b34e5 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 8e02b29)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Fix typos in docs/reference/builder.md.
46cc5c0 
Signed-off-by: Ding Fei <dingfei@stars.org.cn>
(cherry picked from commit 9ccb1f1)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Fix code block fences and typo.
05f08f7 
Signed-off-by: Ding Fei <dingfei@stars.org.cn>
(cherry picked from commit 08fe24c)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@AkihiroSuda @thaJeztah
update docs/reference/commandline/network_inspect.md
fb0b19a 
The following sentences (introduced in v1.11 via moby#21160) were misleading for Swarm mode services (>= v1.12)

  For networks backed by multi-host network driver, such as Overlay,
  this command also shows the container endpoints in other hosts in the
  cluster. These endpoints are represented as "ep-{endpoint-id}" in the output.

Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
(cherry picked from commit 2c288e6)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@yuexiao-wang @thaJeztah
Update the subtitle for stack ps
1b01e2f 
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
(cherry picked from commit 98fb164)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Rewrites to Developing Plugins topic
6f3ad4c 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit b39e65e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@gerwim @thaJeztah
Update docker_remote_api.md
9b63991 
See moby#26099 (comment)

Signed-off-by: Gerwim Feiken <g.feiken@tfe.nl>
(cherry picked from commit 587b186)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Update cURL example for cURL 7.40 differences
ec8c61e 
cURL 7.50 changed the validation for URL's
when using socket connections. cURL 7.4x
did not expect a hostname, whereas cURL
7.5x and above _requires_ a hostname.

See curl/curl#936

This updates the example to take both
versions into account, because cURL 7.4x
is still widely used by distros.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 2e0d6e6)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@elgalu @thaJeztah
Typo --ti and missing my_strace_docker_image
a43b40b 
Signed-off-by: Leo Gallucci <leo.gallucci@zalando.de>
(cherry picked from commit a5b69fa)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@Ghnuberath @thaJeztah
Add HostConfig.Tmpfs to docs for container creation remote API
955c0bd 
Signed-off-by: Sean McIntyre <s.mcintyre@xverba.ca>
(cherry picked from commit 2c38d43)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
28600: Docs: network connect for container in Created/Stopped state
09b09c3 
Signed-off-by: dattatrayakumbhar04 <dattatraya.kumbhar@gslab.com>
(cherry picked from commit 16c9cda)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@bbayani @thaJeztah
Clarify that ipmasq rules are not added when iptables is false
bff68bc 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit db3f06f)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Windows: Note about volumes in run
c00b451 
Signed-off-by: John Howard <jhoward@microsoft.com>
(cherry picked from commit b9e65f4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@lixiaobing1 @thaJeztah
modify invalid url in plugins_network.md
60ff6c6 
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>

(cherry picked from commit fc7c235)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Fix copypaste error 'is-automated'
bf1a4d8 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 2333657)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Document publishing a UDP port
1f6bda6 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 2178c84)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Fix some format errors
63b4965 
Signed-off-by: Yanqiang Miao <miao.yanqiang@zte.com.cn>

update

Signed-off-by: Yanqiang Miao <miao.yanqiang@zte.com.cn>
(cherry picked from commit 71f1205)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@chrisgavin @thaJeztah
Fix a spelling mistake in the docs.
b37fda1 
Signed-off-by: Chris Gavin <chris@chrisgavin.me>
(cherry picked from commit 35c82f4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@pengqinglan @thaJeztah
fix some broken contents links
10b636c 
Signed-off-by: Qinglan Peng <qinglanpeng@zju.edu.cn>

fix-contents-links

Signed-off-by: Qinglan Peng <qinglanpeng@zju.edu.cn>
(cherry picked from commit bac792c)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah thaJeztah changed the title Docs cherry picks [1.12.x] docs cherry picks Dec 12, 2016
mdlinville
mdlinville approved these changes Dec 12, 2016
View reviewed changes
Copy link
Contributor

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question, then LGTM

docs/extend/index.md
description: "How develop and use a plugin with the managed plugin system"
keywords: "API, Usage, plugins, documentation, developer"
advisory: "experimental"
advisory: experimental
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this right? Going from not-experimental to experimental?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it's only removing the quotes (old version had "experimental")

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. LGTM!

@thaJeztah
Copy link
Member Author

thaJeztah commented Dec 12, 2016 •
edited

1.12.x builds are currently running, so wait until the release is built/tagged

@vieux vieux modified the milestone: 1.12.4 Dec 12, 2016
@vdemeester
Copy link
Member

1.12.4 is now released 👼
Merging 👼

@vdemeester vdemeester merged commit 0eb8e72 into moby:1.12.x Dec 13, 2016
@thaJeztah thaJeztah deleted the docs-cherry-picks-1.12.4 branch December 13, 2016 11:21
@thaJeztah thaJeztah mentioned this pull request Jan 17, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdlinville mdlinville mdlinville approved these changes

Assignees
No one assigned
Labels
status/3-docs-review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet