Skip to content
This repository was archived by the owner on Oct 13, 2023. It is now read-only.

Commit 2fbdc02

Browse files
Merge pull request #2557 from thaJeztah/19.03_backport_fix_plugin_api_link
[19.03 backport] docs/extend: fix broken link and some markdown touch-ups Upstream-commit: 2e6ff15dac2d41ae5d84a5398f72a804ee278b63 Component: cli
2 parents a000ffb + 9c06987 commit 2fbdc02

2 files changed

Lines changed: 62 additions & 58 deletions

File tree

components/cli/docs/extend/config.md

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ Config provides the base accessible fields for working with V0 plugin format
3434

3535
- **`description`** *string*
3636

37-
description of the plugin
37+
description of the plugin
3838

3939
- **`documentation`** *string*
4040

41-
link to the documentation about the plugin
41+
link to the documentation about the plugin
4242

4343
- **`interface`** *PluginInterface*
4444

@@ -96,27 +96,27 @@ Config provides the base accessible fields for working with V0 plugin format
9696

9797
- **`name`** *string*
9898

99-
name of the mount.
99+
name of the mount.
100100

101101
- **`description`** *string*
102102

103103
description of the mount.
104104

105105
- **`source`** *string*
106106

107-
source of the mount.
107+
source of the mount.
108108

109109
- **`destination`** *string*
110110

111-
destination of the mount.
111+
destination of the mount.
112112

113113
- **`type`** *string*
114114

115115
mount type.
116116

117117
- **`options`** *string array*
118118

119-
options of the mount.
119+
options of the mount.
120120

121121
- **`ipchost`** *boolean*
122122
Access to host ipc namespace.
@@ -135,31 +135,31 @@ Config provides the base accessible fields for working with V0 plugin format
135135

136136
- **`name`** *string*
137137

138-
name of the env.
138+
name of the env.
139139

140140
- **`description`** *string*
141141

142142
description of the env.
143143

144144
- **`value`** *string*
145145

146-
value of the env.
146+
value of the env.
147147

148148
- **`args`** *PluginArgs*
149149

150150
args of the plugin, struct consisting of the following fields
151151

152152
- **`name`** *string*
153153

154-
name of the args.
154+
name of the args.
155155

156156
- **`description`** *string*
157157

158158
description of the args.
159159

160160
- **`value`** *string array*
161161

162-
values of the args.
162+
values of the args.
163163

164164
- **`linux`** *PluginLinux*
165165

@@ -169,15 +169,15 @@ Config provides the base accessible fields for working with V0 plugin format
169169

170170
- **`allowAllDevices`** *boolean*
171171

172-
If `/dev` is bind mounted from the host, and allowAllDevices is set to true, the plugin will have `rwm` access to all devices on the host.
172+
If `/dev` is bind mounted from the host, and allowAllDevices is set to true, the plugin will have `rwm` access to all devices on the host.
173173

174174
- **`devices`** *PluginDevice array*
175175

176176
device of the plugin, (*Linux only*), struct consisting of the following fields, see [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices)
177177

178178
- **`name`** *string*
179179

180-
name of the device.
180+
name of the device.
181181

182182
- **`description`** *string*
183183

@@ -193,45 +193,45 @@ Config provides the base accessible fields for working with V0 plugin format
193193

194194
```json
195195
{
196-
"Args": {
197-
"Description": "",
198-
"Name": "",
199-
"Settable": null,
200-
"Value": null
201-
},
202-
"Description": "A sample volume plugin for Docker",
203-
"Documentation": "https://docs.docker.com/engine/extend/plugins/",
204-
"Entrypoint": [
205-
"/usr/bin/sample-volume-plugin",
206-
"/data"
207-
],
208-
"Env": [
209-
{
210-
"Description": "",
211-
"Name": "DEBUG",
212-
"Settable": [
213-
"value"
214-
],
215-
"Value": "0"
216-
}
217-
],
218-
"Interface": {
219-
"Socket": "plugin.sock",
220-
"Types": [
221-
"docker.volumedriver/1.0"
222-
]
223-
},
224-
"Linux": {
225-
"Capabilities": null,
226-
"AllowAllDevices": false,
227-
"Devices": null
228-
},
229-
"Mounts": null,
230-
"Network": {
231-
"Type": ""
232-
},
233-
"PropagatedMount": "/data",
234-
"User": {},
235-
"Workdir": ""
196+
"Args": {
197+
"Description": "",
198+
"Name": "",
199+
"Settable": null,
200+
"Value": null
201+
},
202+
"Description": "A sample volume plugin for Docker",
203+
"Documentation": "https://docs.docker.com/engine/extend/plugins/",
204+
"Entrypoint": [
205+
"/usr/bin/sample-volume-plugin",
206+
"/data"
207+
],
208+
"Env": [
209+
{
210+
"Description": "",
211+
"Name": "DEBUG",
212+
"Settable": [
213+
"value"
214+
],
215+
"Value": "0"
216+
}
217+
],
218+
"Interface": {
219+
"Socket": "plugin.sock",
220+
"Types": [
221+
"docker.volumedriver/1.0"
222+
]
223+
},
224+
"Linux": {
225+
"Capabilities": null,
226+
"AllowAllDevices": false,
227+
"Devices": null
228+
},
229+
"Mounts": null,
230+
"Network": {
231+
"Type": ""
232+
},
233+
"PropagatedMount": "/data",
234+
"User": {},
235+
"Workdir": ""
236236
}
237237
```

components/cli/docs/extend/plugins_network.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,18 @@ Once running however, network driver plugins are used just like the built-in
4242
network drivers: by being mentioned as a driver in network-oriented Docker
4343
commands. For example,
4444

45-
$ docker network create --driver weave mynet
45+
```bash
46+
$ docker network create --driver weave mynet
47+
```
4648

4749
Some network driver plugins are listed in [plugins](legacy_plugins.md)
4850

4951
The `mynet` network is now owned by `weave`, so subsequent commands
5052
referring to that network will be sent to the plugin,
5153

52-
$ docker run --network=mynet busybox top
54+
```bash
55+
$ docker run --network=mynet busybox top
56+
```
5357

5458

5559
## Find network plugins
@@ -61,8 +65,8 @@ or on the third party's site.
6165

6266
## Write a network plugin
6367

64-
Network plugins implement the [Docker plugin
65-
API](plugin_api.md) and the network plugin protocol
68+
Network plugins implement the [Docker plugin API](plugin_api.md) and the network
69+
plugin protocol
6670

6771
## Network plugin protocol
6872

@@ -74,5 +78,5 @@ documented as part of libnetwork:
7478

7579
To interact with the Docker maintainers and other interested users, see the IRC channel `#docker-network`.
7680

77-
- [Docker networks feature overview](https://docs.docker.com/engine/userguide/networking/)
78-
- The [LibNetwork](https://github.com/docker/libnetwork) project
81+
- [Docker networks feature overview](https://docs.docker.com/engine/userguide/networking/)
82+
- The [LibNetwork](https://github.com/docker/libnetwork) project

0 commit comments

Comments
 (0)