Skip to content

Commit a5e01e1

Browse files
gdevillelejohndmulhausen
gdevillele
authored and
johndmulhausen
committed
fix type of keywords entry in frontmatter (in /engine/) (docker#552)
keywords should be a string, not an array containing one string Signed-off-by: Gaetan de Villele <[email protected]>
1 parent b1b1ef5 commit a5e01e1

File tree

128 files changed

+317
-445
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+317
-445
lines changed

‎engine/admin/ambassador_pattern_linking.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Using the Ambassador pattern to abstract (network) services
3+
keywords: Examples, Usage, links, docker, documentation, examples, names, name, container naming
24
redirect_from:
35
- /engine/articles/ambassador_pattern_linking/
4-
description: Using the Ambassador pattern to abstract (network) services
5-
keywords:
6-
- Examples, Usage, links, docker, documentation, examples, names, name, container naming
76
title: Link via an ambassador container
87
---
98

@@ -151,4 +150,4 @@ case `192.168.1.52:6379`.
151150
apk add socat && \
152151
rm -r /var/cache/
153152

154-
CMD env | grep _TCP= | (sed 's/.*_PORT_\([0-9]*\)_TCP=tcp:\/\/\(.*\):\(.*\)/socat -t 100000000 TCP4-LISTEN:\1,fork,reuseaddr TCP4:\2:\3 \&/' && echo wait) | sh
153+
CMD env | grep _TCP= | (sed 's/.*_PORT_\([0-9]*\)_TCP=tcp:\/\/\(.*\):\(.*\)/socat -t 100000000 TCP4-LISTEN:\1,fork,reuseaddr TCP4:\2:\3 \&/' && echo wait) | sh

‎engine/admin/ansible.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Installation and using Docker via Ansible
3-
keywords:
4-
- ansible, installation, usage, docker, documentation
3+
keywords: ansible, installation, usage, docker, documentation
54
title: Use Ansible
65
---
76

@@ -62,4 +61,4 @@ The documentation for the `ansible_container` module is present at
6261
[docs.ansible.com](https://docs.ansible.com/ansible/docker_container_module.html).
6362

6463
Documentation covering Docker images, networks and services is also present
65-
at [docs.ansible.com](https://docs.ansible.com/ansible/list_of_cloud_modules.html#docker).
64+
at [docs.ansible.com](https://docs.ansible.com/ansible/list_of_cloud_modules.html#docker).

‎engine/admin/b2d_volume_resize.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
description: Resizing a Boot2Docker volume in VirtualBox with GParted
3+
keywords: boot2docker, volume, virtualbox
34
published: false
4-
keywords:
5-
- boot2docker, volume, virtualbox
65
title: Resize a Boot2Docker volume
76
---
87

@@ -159,4 +158,4 @@ VirtualBox.
159158

160159
<img src="/articles/b2d_volume_images/verify.png">
161160

162-
You're done!
161+
You're done!

‎engine/admin/chef.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Installation and using Docker via Chef
3+
keywords: chef, installation, usage, docker, documentation
24
redirect_from:
35
- /engine/articles/chef/
4-
description: Installation and using Docker via Chef
5-
keywords:
6-
- chef, installation, usage, docker, documentation
76
title: Use Chef
87
---
98

@@ -68,4 +67,4 @@ docker_container 'my_nginx' do
6867
env 'FOO=bar'
6968
subscribes :redeploy, 'docker_image[nginx]'
7069
end
71-
```
70+
```

‎engine/admin/dsc.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Using DSC to configure a new Docker host
3+
keywords: powershell, dsc, installation, usage, docker, documentation
24
redirect_from:
35
- /engine/articles/dsc/
4-
description: Using DSC to configure a new Docker host
5-
keywords:
6-
- powershell, dsc, installation, usage, docker, documentation
76
title: Use PowerShell DSC
87
---
98

@@ -167,4 +166,4 @@ container:
167166
```powershell
168167
$containerProps = @{Name="web"; Image="node:latest"; Port="80:80"; `
169168
Env="PORT=80"; Link="db:db"; Command="grunt"}
170-
```
169+
```

‎engine/admin/formatting.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: CLI and log output formatting reference
3-
keywords:
4-
- format, formatting, output, templates, log
3+
keywords: format, formatting, output, templates, log
54
title: Format command and log output
65
---
76

@@ -69,4 +68,4 @@ Upper turns a string into its upper case representation.
6968

7069
{% raw %}
7170
$ docker inspect --format "{{upper .Name}}" container
72-
{% endraw %}
71+
{% endraw %}

‎engine/admin/host_integration.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: How to generate scripts for upstart, systemd, etc.
3+
keywords: systemd, upstart, supervisor, docker, documentation, host integration
24
redirect_from:
35
- /engine/articles/host_integration/
4-
description: How to generate scripts for upstart, systemd, etc.
5-
keywords:
6-
- systemd, upstart, supervisor, docker, documentation, host integration
76
title: Start containers automatically
87
---
98

@@ -95,4 +94,4 @@ To start using the service, reload systemd and start the service:
9594

9695
To enable the service at system startup, execute:
9796

98-
systemctl enable docker-redis_server.service
97+
systemctl enable docker-redis_server.service

‎engine/admin/index.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2+
description: Configuring and running the Docker daemon on various distributions
3+
keywords: docker, daemon, configuration, running, process managers
24
redirect_from:
35
- /engine/articles/configuring/
46
- /engine/admin/configuring/
5-
description: Configuring and running the Docker daemon on various distributions
6-
keywords:
7-
- docker, daemon, configuration, running, process managers
87
title: Configure and run Docker on various distributions
98
---
109

@@ -300,4 +299,4 @@ May 06 00:22:06 localhost.localdomain docker[2495]: time="2015-05-06T00:22:06Z"
300299
May 06 00:22:06 localhost.localdomain docker[2495]: time="2015-05-06T00:22:06Z" level="info" msg="-job acceptconnections() = OK (0)"
301300
```
302301
303-
> Note: Using and configuring journal is an advanced topic and is beyond the scope of this article.
302+
> Note: Using and configuring journal is an advanced topic and is beyond the scope of this article.

‎engine/admin/live-restore.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: How to keep containers running when the daemon isn't available.
3-
keywords:
4-
- docker, upgrade, daemon, dockerd, live-restore, daemonless container
3+
keywords: docker, upgrade, daemon, dockerd, live-restore, daemonless container
54
title: Keep containers alive during daemon downtime
65
---
76

@@ -72,4 +71,4 @@ You can modify the kernel's buffer size by changing `/proc/sys/fs/pipe-max-size`
7271

7372
The live restore option is not compatible with Docker Engine swarm mode. When
7473
the Docker Engine runs in swarm mode, the orchestration feature manages tasks
75-
and keeps containers running according to a service specification.
74+
and keeps containers running according to a service specification.

‎engine/admin/logging/awslogs.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Describes how to use the Amazon CloudWatch Logs logging driver.
3+
keywords: AWS, Amazon, CloudWatch, logging, driver
24
redirect_from:
35
- /engine/reference/logging/awslogs/
4-
description: Describes how to use the Amazon CloudWatch Logs logging driver.
5-
keywords:
6-
- AWS, Amazon, CloudWatch, logging, driver
76
title: Amazon CloudWatch Logs logging driver
87
---
98

@@ -83,4 +82,4 @@ and `logs:PutLogEvents` actions, as shown in the following example.
8382
"Resource": "*"
8483
}
8584
]
86-
}
85+
}

‎engine/admin/logging/etwlogs.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describes how to use the etwlogs logging driver.
3-
keywords:
4-
- ETW, docker, logging, driver
3+
keywords: ETW, docker, logging, driver
54
title: ETW logging driver
65
---
76

@@ -59,4 +58,4 @@ context information. Note that the time stamp is also available within the ETW e
5958

6059
**Note** This ETW provider emits only a message string, and not a specially
6160
structured ETW event. Therefore, it is not required to register a manifest file
62-
with the system to read and interpret its ETW events.
61+
with the system to read and interpret its ETW events.

‎engine/admin/logging/fluentd.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2+
description: Describes how to use the fluentd logging driver.
3+
keywords: Fluentd, docker, logging, driver
24
redirect_from:
35
- /engine/reference/logging/fluentd/
46
- /reference/logging/fluentd/
5-
description: Describes how to use the fluentd logging driver.
6-
keywords:
7-
- Fluentd, docker, logging, driver
87
title: Fluentd logging driver
98
---
109

@@ -110,4 +109,4 @@ aggregate store.
110109

111110
3. Start one or more containers with the `fluentd` logging driver:
112111

113-
$ docker run --log-driver=fluentd your/application
112+
$ docker run --log-driver=fluentd your/application

‎engine/admin/logging/gcplogs.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describes how to use the Google Cloud Logging driver.
3-
keywords:
4-
- gcplogs, google, docker, logging, driver
3+
keywords: gcplogs, google, docker, logging, driver
54
title: Google Cloud Logging driver
65
---
76

@@ -64,4 +63,4 @@ logging destination which is discovered by querying the GCE metadata server.
6463

6564
This configuration also directs the driver to include in the payload the label
6665
`location`, the environment variable `ENV`, and the command used to start the
67-
container.
66+
container.

‎engine/admin/logging/index.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Logging and Logging Drivers
3+
keywords: ' docker, logging, driver'
24
redirect_from:
35
- /engine/reference/logging/
4-
description: Logging and Logging Drivers
5-
keywords:
6-
- ' docker, logging, driver'
76
title: Logging drivers
87
---
98

@@ -14,4 +13,4 @@ title: Logging drivers
1413
* [Amazon CloudWatch Logs logging driver](awslogs.md)
1514
* [Splunk logging driver](splunk.md)
1615
* [ETW logging driver](etwlogs.md)
17-
* [Google Cloud Logging driver](gcplogs.md)
16+
* [Google Cloud Logging driver](gcplogs.md)

‎engine/admin/logging/journald.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Describes how to use the fluentd logging driver.
3+
keywords: Journald, docker, logging, driver
24
redirect_from:
35
- /engine/reference/logging/journald/
4-
description: Describes how to use the fluentd logging driver.
5-
keywords:
6-
- Journald, docker, logging, driver
76
title: Journald logging driver
87
---
98

@@ -88,4 +87,4 @@ logs:
8887
reader.add_match('CONTAINER_NAME=web')
8988

9089
for msg in reader:
91-
print '{CONTAINER_ID_FULL}: {MESSAGE}'.format(**msg)
90+
print '{CONTAINER_ID_FULL}: {MESSAGE}'.format(**msg)

‎engine/admin/logging/log_tags.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Describes how to format tags for.
3+
keywords: docker, logging, driver, syslog, Fluentd, gelf, journald
24
redirect_from:
35
- /engine/reference/logging/log_tags/
4-
description: Describes how to format tags for.
5-
keywords:
6-
- docker, logging, driver, syslog, Fluentd, gelf, journald
76
title: Log tags for logging driver
87
---
98

@@ -62,4 +61,4 @@ Results in logs like this:
6261
```
6362
Apr 1 15:22:17 ip-10-27-39-73 docker/logtester.1234[45499]: + exec app
6463
Apr 1 15:22:17 ip-10-27-39-73 docker/logtester.1234[45499]: 2016-04-01 15:22:17.075416751 +0000 UTC stderr msg: 1
65-
```
64+
```

‎engine/admin/logging/overview.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Configure logging driver.
3+
keywords: docker, logging, driver, Fluentd
24
redirect_from:
35
- /engine/reference/logging/overview/
4-
description: Configure logging driver.
5-
keywords:
6-
- docker, logging, driver, Fluentd
76
title: Configure logging drivers
87
---
98

@@ -298,4 +297,4 @@ The Google Cloud Logging driver supports the following options:
298297
```
299298

300299
For detailed information about working with this logging driver, see the
301-
[Google Cloud Logging driver](gcplogs.md). reference documentation.
300+
[Google Cloud Logging driver](gcplogs.md). reference documentation.

‎engine/admin/logging/splunk.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Describes how to use the Splunk logging driver.
3+
keywords: splunk, docker, logging, driver
24
redirect_from:
35
- /engine/reference/logging/splunk/
4-
description: Describes how to use the Splunk logging driver.
5-
keywords:
6-
- splunk, docker, logging, driver
76
title: Splunk logging driver
87
---
98

@@ -65,4 +64,4 @@ The `SplunkServerDefaultCert` is automatically generated by Splunk certificates.
6564
--env "TEST=false"
6665
--label location=west
6766
your/application
68-
{% endraw %}
67+
{% endraw %}

‎engine/admin/puppet.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Installing and using Puppet
3+
keywords: puppet, installation, usage, docker, documentation
24
redirect_from:
35
- /engine/articles/puppet/
4-
description: Installing and using Puppet
5-
keywords:
6-
- puppet, installation, usage, docker, documentation
76
title: Use Puppet
87
---
98

@@ -93,4 +92,4 @@ Run also contains a number of optional parameters:
9392

9493
> *Note:*
9594
> The `ports`, `env`, `dns` and `volumes` attributes can be set with either a single
96-
> string or as above with an array of values.
95+
> string or as above with an array of values.

‎engine/admin/registry_mirror.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
2+
description: How to set up and run a local registry mirror
3+
keywords: docker, registry, mirror, examples
24
redirect_from:
35
- /engine/articles/registry_mirror/
4-
description: How to set up and run a local registry mirror
5-
keywords:
6-
- docker, registry, mirror, examples
76
title: Run a local registry mirror
87
---
98

109
The original content was deprecated. [An archived
1110
version](/v1.6/articles/registry_mirror) is available in
1211
the 1.7 documentation. For information about configuring mirrors with the latest
1312
Docker Registry version, please file a support request with [the Distribution
14-
project](https://github.com/docker/distribution/issues).
13+
project](https://github.com/docker/distribution/issues).

‎engine/admin/runmetrics.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2+
description: Measure the behavior of running containers
3+
keywords: docker, metrics, CPU, memory, disk, IO, run, runtime, stats
24
redirect_from:
35
- /engine/articles/run_metrics
46
- /engine/articles/runmetrics
5-
description: Measure the behavior of running containers
6-
keywords:
7-
- docker, metrics, CPU, memory, disk, IO, run, runtime, stats
87
title: Runtime metrics
98
---
109

@@ -383,4 +382,4 @@ and remove the container control group. To remove a control group, just
383382
`rmdir` its directory. It's counter-intuitive to
384383
`rmdir` a directory as it still contains files; but
385384
remember that this is a pseudo-filesystem, so usual rules don't apply.
386-
After the cleanup is done, the collection process can exit safely.
385+
After the cleanup is done, the collection process can exit safely.

0 commit comments

Comments
 (0)