Update CLI reference yaml for 17.03.1 #2633
Conversation
_data/engine-cli/docker_ps.yaml
Outdated
| @@ -348,7 +348,6 @@ examples: |- | |||
| ``` | |||
|
|
|||
| The following filter matches all containers that have exposed TCP port in the range of `8000-8080`: | |||
|
|
|||
There was a problem hiding this comment.
I think this is a bug. :( I will manually change it for now but we need to put the spaces back in the 17.03.x branch of docker/docker....
There was a problem hiding this comment.
@tiborvass the source file is correct. Maybe the YAML generator is eating the newlines?
_data/engine-cli/docker_push.yaml
Outdated
| If you are on a low bandwidth connection this may cause timeout issues and you may want to lower | ||
| this via the `--max-concurrent-uploads` daemon option. See the | ||
| [daemon documentation](dockerd.md) for more details. | ||
| long: "Use `docker push` to share your images to the [Docker Hub](https://hub.docker.com)\nregistry |
There was a problem hiding this comment.
This is wrong syntax, I think....
There was a problem hiding this comment.
@tiborvass I don't see anything in the source file that is causing this. Why is the YAML generator not putting the |-?
| long: |- | ||
| Creates a secret using standard input or from a file for the secret content. You must run this | ||
| command on a manager node. | ||
| long: "Creates a secret using standard input or from a file for the secret content. |
There was a problem hiding this comment.
This is wrong syntax, I think...
There was a problem hiding this comment.
@tiborvass I don't see anything in the source file that is causing this. Why is the YAML generator not putting the |-?
_data/engine-cli/docker_system.yaml
Outdated
| @@ -1,6 +1,6 @@ | |||
| command: docker system | |||
| short: Manage Docker | |||
| long: Manage Docker | |||
| long: Manage docker. | |||
There was a problem hiding this comment.
I wonder why this change was made...
_data/engine-cli/docker_volume.yaml
Outdated
| For full details on using docker volume visit Docker's online documentation. | ||
|
|
||
| long: |- | ||
| Manage volumes. You can use subcommand to create, list, inspect, remove |
There was a problem hiding this comment.
Should be s/subcommand/subcommands
|
See moby/moby#32382 |
|
Just pushed a second commit to manually address the mistakes in the YAML files this time. |
_data/engine-cli/docker_push.yaml
Outdated
| uncompressed size. The \nactual amount of data that's pushed will be compressed | ||
| before sending, so the uploaded\n size will not be reflected by the progress bar. | ||
| \n\nRegistry credentials are managed by [docker login](login.md).\n\n### Concurrent | ||
| uploads\n\nBy default the Docker daemon will push five layers of an image at a time.\nIf |
There was a problem hiding this comment.
Is this something that needs to be addressed in the YAML generator?
| @@ -1,22 +1,8 @@ | |||
| command: docker volume | |||
| short: Manage volumes | |||
| long: |2+ | |||
|
|
|||
| The **docker volume** command has subcommands for managing data volumes. A data | |||
There was a problem hiding this comment.
Did we remove this section deliberately?
|
This does not yet remove the |
|
You are right. I will generate this again and make a new PR. |
How I did this:
In
docker/dockerrepo branch17.03.x:The YAML files are saved to
./bundles/17.03.1-ce/yaml-docs-generator/docs/In
docker/docker.github.iorepo branchmaster, copied the contents of the above directory to_data/engine-cli`, added all changed files, and committed.