Skip to content

Commit c56964c

Browse files
gdevillelejohndmulhausen
authored andcommitted
fix type of keywords entry in frontmatter (in /swarm/ dir and search.md and release-notes.md) (#515)
keywords should be a string, not an array containing one string Signed-off-by: Gaetan de Villele <[email protected]>
1 parent 06e2875 commit c56964c

32 files changed

+71
-103
lines changed

release-notes.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Release notes for Docker
3-
keywords:
4-
- docker, documentation, about, technology, understanding, release
3+
keywords: docker, documentation, about, technology, understanding, release
54
title: Docker Release Notes
65
---
76

@@ -18,4 +17,4 @@ target="_blank">Docker Machine</a>
1817
* <a href="https://github.com/docker/compose/blob/master/CHANGELOG.md"
1918
target="_blank">Docker Compose</a>
2019
* <a href="https://github.com/docker/swarm/blob/master/CHANGELOG.md"
21-
target="_blank">Docker Swarm</a>
20+
target="_blank">Docker Swarm</a>

search.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
description: Docker documentation search results
3-
keywords:
4-
- Search, Docker, documentation, manual, guide, reference, api
3+
keywords: Search, Docker, documentation, manual, guide, reference, api
4+
noratings: true
55
notoc: true
66
title: Search results
7-
noratings: true
87
---
98

109
<style type='text/css'>
@@ -34,4 +33,4 @@ noratings: true
3433
})();
3534
</script>
3635
<gcse:search></gcse:search>
37-
</div>
36+
</div>

swarm/configure-tls.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Swarm and transport layer security
3-
keywords:
4-
- docker, swarm, TLS, discovery, security, certificates
3+
keywords: docker, swarm, TLS, discovery, security, certificates
54
title: Configure Docker Swarm for TLS
65
---
76

@@ -540,4 +539,4 @@ Congratulations! You have configured a Docker Swarm cluster to use TLS.
540539
## Related Information
541540
542541
* [Secure Docker Swarm with TLS](secure-swarm-tls.md)
543-
* [Docker security](/engine/security/security/)
542+
* [Docker security](/engine/security/security/)

swarm/discovery.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Swarm discovery
3-
keywords:
4-
- docker, swarm, clustering, discovery
3+
keywords: docker, swarm, clustering, discovery
54
title: Docker Swarm discovery
65
---
76

@@ -216,4 +215,4 @@ github.com/docker/docker/pkg/discovery</a>.
216215
- [Docker Swarm overview](index.md)
217216
- [Scheduler strategies](scheduler/strategy.md)
218217
- [Scheduler filters](scheduler/filter.md)
219-
- [Swarm API](swarm-api.md)
218+
- [Swarm API](swarm-api.md)

swarm/get-swarm.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Running a Swarm container on Docker Engine. Run a Swarm binary on the host OS without Docker Engine.
3-
keywords:
4-
- docker, Swarm, container, binary, clustering, install, installation
3+
keywords: docker, Swarm, container, binary, clustering, install, installation
54
title: Get Docker Swarm
65
---
76

@@ -117,4 +116,4 @@ software tools, such as Docker Engine CLI at the node level.
117116
## Related information
118117

119118
* [Docker Swarm official image](https://hub.docker.com/_/swarm/) repository on Docker Hub
120-
* [Provision a Swarm with Docker Machine](provision-with-machine.md)
119+
* [Provision a Swarm with Docker Machine](provision-with-machine.md)

swarm/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: 'Swarm: a Docker-native clustering system'
3-
keywords:
4-
- docker, swarm, clustering
3+
keywords: docker, swarm, clustering
54
title: Docker Swarm
65
---
76

@@ -18,4 +17,4 @@ title: Docker Swarm
1817
* [Swarm and container networks](networking.md)
1918
* [Advanced Scheduling](scheduler/index.md)
2019
* [Provision a Swarm cluster with Docker Machine](provision-with-machine.md)
21-
* [Docker Swarm API](swarm-api.md)
20+
* [Docker Swarm API](swarm-api.md)

swarm/install-manual.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Deploying Swarm on AWS EC2 AMI's in a VPC
3-
keywords:
4-
- docker, swarm, clustering, examples, Amazon, AWS EC2
3+
keywords: docker, swarm, clustering, examples, Amazon, AWS EC2
54
title: Build a Swarm cluster for production
65
---
76

@@ -300,4 +299,4 @@ They will display corresponding entries for the change in leadership.
300299
- [High availability in Docker Swarm](multi-manager-setup.md)
301300
- [Discovery](discovery.md)
302301
- [High-availability cluster using a trio of consul nodes](https://hub.docker.com/r/progrium/consul/)
303-
- [Networking](networking.md)
302+
- [Networking](networking.md)

swarm/install-w-machine.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Swarm release notes
3-
keywords:
4-
- docker, swarm, clustering, discovery, release, notes
3+
keywords: docker, swarm, clustering, discovery, release, notes
54
menu:
65
main:
76
parent: workw_swarm
@@ -258,4 +257,4 @@ At this point, you've installed Docker Swarm by pulling the latest image of
258257
it from Docker Hub. Then, you built and ran a swarm on your local machine
259258
using VirtualBox. If you want, you can onto read an [overview of Docker Swarm
260259
features](index.md). Alternatively, you can develop a more in-depth view of Swarm by
261-
[manually installing Swarm](install-manual.md) on a network.
260+
[manually installing Swarm](install-manual.md) on a network.

swarm/multi-manager-setup.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: High availability in Swarm
3-
keywords:
4-
- docker, swarm, clustering
3+
keywords: docker, swarm, clustering
54
title: High availability in Docker Swarm
65
---
76

@@ -156,4 +155,4 @@ To switch the `DOCKER_HOST` to use `manager-2` as the primary, you do the follow
156155

157156
You can use the `docker` command on any Docker Swarm primary manager or any replica.
158157

159-
If you like, you can use custom mechanisms to always point `DOCKER_HOST` to the current primary manager. Then, you never lose contact with your Docker Swarm in the event of a failover.
158+
If you like, you can use custom mechanisms to always point `DOCKER_HOST` to the current primary manager. Then, you never lose contact with your Docker Swarm in the event of a failover.

swarm/networking.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Swarm and container networks
3-
keywords:
4-
- docker, swarm, clustering, networking
3+
keywords: docker, swarm, clustering, networking
54
title: Swarm and container networks
65
---
76

@@ -127,4 +126,4 @@ from `node-0`.
127126
- [Docker Swarm overview](index.md)
128127
- [Scheduler strategies](scheduler/strategy.md)
129128
- [Scheduler filters](scheduler/filter.md)
130-
- [Swarm API](swarm-api.md)
129+
- [Swarm API](swarm-api.md)

swarm/overview.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: 'Swarm: a Docker-native clustering system'
3-
keywords:
4-
- docker, swarm, clustering
3+
keywords: docker, swarm, clustering
54
title: Docker Swarm overview
65
---
76

@@ -74,4 +73,4 @@ like-minded individuals, we have a number of open channels for communication.
7473

7574
* To contribute code or documentation changes: please submit a [pull request on Github](https://github.com/docker/swarm/pulls).
7675

77-
For more information and resources, please visit the [Getting Help project page](/project/get-help/).
76+
For more information and resources, please visit the [Getting Help project page](/project/get-help/).

swarm/plan-for-production.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Plan for Swarm in production
3-
keywords:
4-
- docker, swarm, scale, voting, application, plan
3+
keywords: docker, swarm, scale, voting, application, plan
54
title: Plan for Swarm in production
65
---
76

@@ -344,4 +343,4 @@ planning, deployment, and ongoing management of your production Swarm clusters.
344343
* [Try Swarm at scale](swarm_at_scale/index.md)
345344
* [Swarm and container networks](networking.md)
346345
* [High availability in Docker Swarm](multi-manager-setup.md)
347-
* [Docker Data Center](https://www.docker.com/products/docker-datacenter)
346+
* [Docker Data Center](https://www.docker.com/products/docker-datacenter)

swarm/provision-with-machine.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Provision with Machine
3-
keywords:
4-
- docker, Swarm, clustering, provision, Machine
3+
keywords: docker, Swarm, clustering, provision, Machine
54
title: Provision a Swarm cluster with Docker Machine
65
---
76

@@ -180,4 +179,4 @@ Name: swarm-manager
180179
* [Evaluate Swarm in a sandbox](install-w-machine.md)
181180
* [Build a Swarm cluster for production](install-manual.md)
182181
* [Swarm Discovery](discovery.md)
183-
* [Docker Machine](/machine) documentation
182+
* [Docker Machine](/machine) documentation

swarm/reference/create.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Create a Swarm manager.
3-
keywords:
4-
- swarm, create
3+
keywords: swarm, create
54
title: create — Create a discovery token
65
---
76

@@ -16,4 +15,4 @@ Some documentation also refers to the discovery token as a *cluster_id*.
1615

1716
> Warning: Docker Hub's hosted discovery backend is not recommended for production use. It’s intended only for testing/development.
1817
19-
For more information and examples about this and other discovery backends, see the [Docker Swarm Discovery](../discovery.md) topic.
18+
For more information and examples about this and other discovery backends, see the [Docker Swarm Discovery](../discovery.md) topic.

swarm/reference/help.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Get help for Swarm commands.
3-
keywords:
4-
- swarm, help
3+
keywords: swarm, help
54
title: help - Display information about a command
65
---
76

@@ -33,4 +32,4 @@ For example:
3332

3433
Options:
3534
--timeout "10s" timeout period
36-
--discovery-opt [--discovery-opt option --discovery-opt option] discovery options
35+
--discovery-opt [--discovery-opt option --discovery-opt option] discovery options

swarm/reference/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Docker Swarm Commands Overview
3-
keywords:
4-
- Swarm, cluster, commands
3+
keywords: Swarm, cluster, commands
54
title: Swarm command-line reference
65
---
76

@@ -10,4 +9,4 @@ title: Swarm command-line reference
109
- [list](list.md) — List the nodes in a Docker cluster
1110
- [manage](manage.md) — Create a Swarm manager
1211
- [join](join.md) — Create a Swarm node
13-
- [help](help.md) — See a list of Swarm commands, or help for one command
12+
- [help](help.md) — See a list of Swarm commands, or help for one command

swarm/reference/join.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Create a Swarm node.
3-
keywords:
4-
- swarm, create, join
3+
keywords: swarm, create, join
54
title: join — Create a Swarm node
65
---
76

@@ -87,4 +86,4 @@ Use `--discovery-opt <value>` to discovery options, such as paths to the TLS fil
8786
--discovery-opt kv.certfile=/path/to/mycert.pem \
8887
--discovery-opt kv.keyfile=/path/to/mykey.pem \
8988

90-
For more information, see [Use TLS with distributed key/value discovery](../discovery.md)
89+
For more information, see [Use TLS with distributed key/value discovery](../discovery.md)

swarm/reference/list.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: List the nodes in a cluster.
3-
keywords:
4-
- swarm, list
3+
keywords: swarm, list
54
title: list — List the nodes in a cluster
65
---
76

@@ -77,4 +76,4 @@ Use `--discovery-opt <value>` to discovery options, such as paths to the TLS fil
7776
--discovery-opt kv.certfile=/path/to/mycert.pem \
7877
--discovery-opt kv.keyfile=/path/to/mykey.pem \
7978

80-
For more information, see [Use TLS with distributed key/value discovery](../discovery.md)
79+
For more information, see [Use TLS with distributed key/value discovery](../discovery.md)

swarm/reference/manage.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Create a Swarm manager.
3-
keywords:
4-
- swarm, create, manage
3+
keywords: swarm, create, manage
54
title: manage — Create a Swarm manager
65
---
76

@@ -199,4 +198,4 @@ Use `--discovery-opt <value>` to discovery options, such as paths to the TLS fil
199198
--discovery-opt kv.certfile=/path/to/mycert.pem \
200199
--discovery-opt kv.keyfile=/path/to/mykey.pem \
201200

202-
For more information, see [Use TLS with distributed key/value discovery](../discovery.md)
201+
For more information, see [Use TLS with distributed key/value discovery](../discovery.md)

swarm/reference/swarm.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
description: swarm command overview
3-
keywords:
4-
- Swarm, cluster, commands
5-
title: "Swarm: A Docker-native clustering system"
3+
keywords: Swarm, cluster, commands
4+
title: 'Swarm: A Docker-native clustering system'
65
---
76

87
The `swarm` command runs a Swarm container on a Docker Engine host and performs the task specified by the required subcommand, `COMMAND`.
@@ -37,4 +36,4 @@ The `swarm` command has the following subcommands:
3736
- [list, l](list.md) - List the nodes in a Docker cluster
3837
- [manage, m](manage.md) - Create a Swarm manager
3938
- [join, j](join.md) - Create a Swarm node
40-
- [help](help.md) - Display a list of Swarm commands, or help for one command
39+
- [help](help.md) - Display a list of Swarm commands, or help for one command

swarm/scheduler/filter.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Swarm filters
3-
keywords:
4-
- docker, swarm, clustering, filters
3+
keywords: docker, swarm, clustering, filters
54
title: Swarm filters
65
---
76

@@ -519,4 +518,4 @@ without a container that satisfies `redis*`
519518
- [Docker Swarm overview](../index.md)
520519
- [Discovery options](../discovery.md)
521520
- [Scheduler strategies](strategy.md)
522-
- [Swarm API](../swarm-api.md)
521+
- [Swarm API](../swarm-api.md)

swarm/scheduler/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
description: 'Swarm: a Docker-native clustering system'
3-
keywords:
4-
- docker, swarm, clustering, scheduling
3+
keywords: docker, swarm, clustering, scheduling
54
title: Advanced Scheduling
65
---
76

87
To learn more about advanced scheduling, see the [strategies](strategy.md),
9-
[rescheduling](rescheduling.md), and [filters](filter.md) documents.
8+
[rescheduling](rescheduling.md), and [filters](filter.md) documents.

swarm/scheduler/rescheduling.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Swarm rescheduling
3-
keywords:
4-
- docker, swarm, clustering, rescheduling
3+
keywords: docker, swarm, clustering, rescheduling
54
title: Swarm rescheduling
65
---
76

@@ -56,4 +55,4 @@ Failed to start rescheduled container 2362901cb213da321
5655
## Related information
5756

5857
* [Apply custom metadata](/engine/userguide/labels-custom-metadata/)
59-
* [Environment variables with run](/engine/reference/run/#env-environment-variables)
58+
* [Environment variables with run](/engine/reference/run/#env-environment-variables)

swarm/scheduler/strategy.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Swarm strategies
3-
keywords:
4-
- docker, swarm, clustering, strategies
3+
keywords: docker, swarm, clustering, strategies
54
title: Docker Swarm strategies
65
---
76

@@ -119,4 +118,4 @@ strategy prefers the node with most containers.
119118
- [Docker Swarm overview](../index.md)
120119
- [Discovery options](../discovery.md)
121120
- [Scheduler filters](filter.md)
122-
- [Swarm API](../swarm-api.md)
121+
- [Swarm API](../swarm-api.md)

0 commit comments

Comments
 (0)