mirror of https://github.com/docker/cli.git
Merge pull request #2609 from thaJeztah/19.03_backport_docs_fixes
[19.03 backport] assorted docs fixes
This commit is contained in:
commit
cb59cafc3e
|
@ -38,8 +38,8 @@ plugin
|
||||||
|
|
||||||
$ docker plugin ls
|
$ docker plugin ls
|
||||||
|
|
||||||
ID NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
672d8144ec02 plugin latest A sample plugin for Docker false
|
672d8144ec02 plugin:latest A sample plugin for Docker false
|
||||||
```
|
```
|
||||||
|
|
||||||
The plugin can subsequently be enabled for local use or pushed to the public registry.
|
The plugin can subsequently be enabled for local use or pushed to the public registry.
|
||||||
|
|
|
@ -30,8 +30,8 @@ and enabled:
|
||||||
```bash
|
```bash
|
||||||
$ docker plugin ls
|
$ docker plugin ls
|
||||||
|
|
||||||
ID NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker true
|
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker true
|
||||||
```
|
```
|
||||||
|
|
||||||
To disable the plugin, use the following command:
|
To disable the plugin, use the following command:
|
||||||
|
@ -43,8 +43,8 @@ tiborvass/sample-volume-plugin
|
||||||
|
|
||||||
$ docker plugin ls
|
$ docker plugin ls
|
||||||
|
|
||||||
ID NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker false
|
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker false
|
||||||
```
|
```
|
||||||
|
|
||||||
## Related commands
|
## Related commands
|
||||||
|
|
|
@ -29,8 +29,8 @@ but disabled:
|
||||||
```bash
|
```bash
|
||||||
$ docker plugin ls
|
$ docker plugin ls
|
||||||
|
|
||||||
ID NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker false
|
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker false
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable the plugin, use the following command:
|
To enable the plugin, use the following command:
|
||||||
|
@ -42,8 +42,8 @@ tiborvass/sample-volume-plugin
|
||||||
|
|
||||||
$ docker plugin ls
|
$ docker plugin ls
|
||||||
|
|
||||||
ID NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker true
|
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker true
|
||||||
```
|
```
|
||||||
|
|
||||||
## Related commands
|
## Related commands
|
||||||
|
|
|
@ -49,8 +49,8 @@ After the plugin is installed, it appears in the list of plugins:
|
||||||
```bash
|
```bash
|
||||||
$ docker plugin ls
|
$ docker plugin ls
|
||||||
|
|
||||||
ID NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
69553ca1d123 vieux/sshfs latest sshFS plugin for Docker true
|
69553ca1d123 vieux/sshfs:latest sshFS plugin for Docker true
|
||||||
```
|
```
|
||||||
|
|
||||||
## Related commands
|
## Related commands
|
||||||
|
|
|
@ -34,8 +34,8 @@ Refer to the [filtering](#filtering) section for more information about availabl
|
||||||
```bash
|
```bash
|
||||||
$ docker plugin ls
|
$ docker plugin ls
|
||||||
|
|
||||||
ID NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker true
|
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker true
|
||||||
```
|
```
|
||||||
|
|
||||||
### Filtering
|
### Filtering
|
||||||
|
@ -65,7 +65,7 @@ Installed plugin vieux/sshfs
|
||||||
|
|
||||||
$ docker plugin ls --filter enabled=true
|
$ docker plugin ls --filter enabled=true
|
||||||
|
|
||||||
NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
```
|
```
|
||||||
|
|
||||||
### Formatting
|
### Formatting
|
||||||
|
@ -78,7 +78,7 @@ Valid placeholders for the Go template are listed below:
|
||||||
Placeholder | Description
|
Placeholder | Description
|
||||||
-------------------|------------------------------------------------------------
|
-------------------|------------------------------------------------------------
|
||||||
`.ID` | Plugin ID
|
`.ID` | Plugin ID
|
||||||
`.Name` | Plugin name
|
`.Name` | Plugin name and tag
|
||||||
`.Description` | Plugin description
|
`.Description` | Plugin description
|
||||||
`.Enabled` | Whether plugin is enabled or not
|
`.Enabled` | Whether plugin is enabled or not
|
||||||
`.PluginReference` | The reference used to push/pull from a registry
|
`.PluginReference` | The reference used to push/pull from a registry
|
||||||
|
|
|
@ -29,8 +29,8 @@ The following example shows how to push a sample `user/plugin`.
|
||||||
```bash
|
```bash
|
||||||
$ docker plugin ls
|
$ docker plugin ls
|
||||||
|
|
||||||
ID NAME TAG DESCRIPTION ENABLED
|
ID NAME DESCRIPTION ENABLED
|
||||||
69553ca1d456 user/plugin latest A sample plugin for Docker false
|
69553ca1d456 user/plugin:latest A sample plugin for Docker false
|
||||||
|
|
||||||
$ docker plugin push user/plugin
|
$ docker plugin push user/plugin
|
||||||
```
|
```
|
||||||
|
|
|
@ -103,7 +103,7 @@ tz6j82jnwrx7 voting_db.1 postgres:9.4
|
||||||
|
|
||||||
#### desired-state
|
#### desired-state
|
||||||
|
|
||||||
The `desired-state` filter can take the values `running`, `shutdown`, or `accepted`.
|
The `desired-state` filter can take the values `running`, `shutdown`, `ready` or `accepted`.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ docker stack ps -f "desired-state=running" voting
|
$ docker stack ps -f "desired-state=running" voting
|
||||||
|
|
Loading…
Reference in New Issue