Skip to content

Commit b6b1ed1

Browse files
committed
fix type of keywords entry in frontmatter (in /opensource/)
keywords should be a string, not an array containing one string Signed-off-by: Gaetan de Villele <[email protected]>
1 parent 3544131 commit b6b1ed1

36 files changed

+75
-112
lines changed

opensource/FAQ.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Overview of contributing
3-
keywords:
4-
- open, source, contributing, overview
3+
keywords: open, source, contributing, overview
54
title: FAQ for contributors
65
---
76

@@ -136,4 +135,4 @@ force the previous change to be overwritten.
136135
137136
```
138137
$ git push -f origin my-keen-feature
139-
```
138+
```

opensource/code.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Contribute code
3+
keywords: governance, board, members, profiles
24
redirect_from:
35
- /contributing/contributing
4-
description: Contribute code
5-
keywords:
6-
- governance, board, members, profiles
76
title: Quickstart code or doc contribution
87
---
98

@@ -77,4 +76,4 @@ pull request</a>.
7776

7877
7. <a href="http://docs.docker.com/opensource/workflow/review-pr/"
7978
target="_blank">Participate in the pull request review</a> till a successful
80-
merge.
79+
merge.

opensource/doc-style.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Style guide for Docker documentation describing standards and conventions for contributors
3-
keywords:
4-
- style, guide, docker, documentation
3+
keywords: style, guide, docker, documentation
54
title: Documentation style and grammar conventions
65
---
76

@@ -274,4 +273,4 @@ call-outs is red.
274273
Be sure to include descriptive alt-text for the graphic. This greatly helps
275274
users with accessibility issues.
276275

277-
Lastly, be sure you have permission to use any included graphics.
276+
Lastly, be sure you have permission to use any included graphics.

opensource/get-help.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describes Docker's communication channels
3-
keywords:
4-
- IRC, Google group, Twitter, blog, Stackoverflow
3+
keywords: IRC, Google group, Twitter, blog, Stackoverflow
54
title: Where to chat or get help
65
---
76

@@ -217,4 +216,4 @@ This quickstart was meant to get you up and into IRC very quickly. If you find
217216
IRC useful there is more to learn. Drupal, another open source project,
218217
has <a href="https://www.drupal.org/irc/setting-up" target="_blank">
219218
written some documentation about using IRC</a> for their project
220-
(thanks Drupal!).
219+
(thanks Drupal!).

opensource/governance/board-profiles.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Board member profiles
3-
keywords:
4-
- governance, board, members, profiles
3+
keywords: governance, board, members, profiles
54
title: Board member profiles
65
---
76

@@ -62,4 +61,4 @@ and community of the Docker Project.
6261
* Nicola Paolucci (Atlassian)
6362
* Burke Libbey (Shopify)
6463
* Meghdoot Bhattacharya (PayPal)
65-
* Tapabrata Pal (Capital One)
64+
* Tapabrata Pal (Capital One)

opensource/governance/conduct-code.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains Docker's code of conduct
3-
keywords:
4-
- Docker, conduct, code
3+
keywords: Docker, conduct, code
54
title: Code of conduct
65
---
76

@@ -37,4 +36,4 @@ maintainers.
3736

3837
This Code of Conduct is adapted from the [Contributor
3938
Covenant](http://contributor-covenant.org), version 1.0.0, available at
40-
[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
39+
[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

opensource/governance/dgab-info.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
description: Docker Governance Advisory Board
3-
keywords:
4-
- governance, board, members, explained
5-
title: "Docker Governance Advisory Board: June 2015 version"
3+
keywords: governance, board, members, explained
4+
title: 'Docker Governance Advisory Board: June 2015 version'
65
---
76

87
An initial version of this proposal was posted for comments on April 30th,
@@ -190,4 +189,4 @@ will either agree to become compliant within a specified timeframe or else
190189
resign their DGAB position.
191190

192191
Please help us improve this draft by sending your comments and feedback to
193-
192+

opensource/governance/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
description: Describes Docker's communication channels
3-
keywords:
4-
- IRC, Google group, Twitter, blog, Stackoverflow
3+
keywords: IRC, Google group, Twitter, blog, Stackoverflow
54
title: Governance
65
---
76

87
* [Docker Governance Advisory Board](dgab-info.md )
98
* [Board member profiles](board-profiles.md )
10-
* [Code of conduct](conduct-code.md)
9+
* [Code of conduct](conduct-code.md)

opensource/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Overview of contributing
3-
keywords:
4-
- open, source, contributing, overview
3+
keywords: open, source, contributing, overview
54
title: Open Source at Docker
65
---
76

@@ -12,4 +11,4 @@ You also help the countless number of other project participants.
1211
- [Configure the development environment](project/who-written-for.md) explains how to setup an environment to contribute to Docker engine.
1312
- [Understand the contribution workflow ](workflow/make-a-contribution.md) explains the workflow the team uses across most Docker projects.
1413
- [Other ways to contribute](ways/index.md) provides tips for contributing if you don't want to code.
15-
- [Governance](governance/index.md) describes the proper conduct and who defines it.
14+
- [Governance](governance/index.md) describes the proper conduct and who defines it.

opensource/kitematic/create_pr.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains how to create a pull request for change or new feature
3-
keywords:
4-
- Kitematic, open source, contribute, contributor, tour, development, contribute, pull request, review, workflow, beginner, squash, commit
3+
keywords: Kitematic, open source, contribute, contributor, tour, development, contribute, pull request, review, workflow, beginner, squash, commit
54
title: Create a pull request (PR)
65
---
76

@@ -58,4 +57,4 @@ The next step in this process is to participate your PR's review. To learn more,
5857

5958
<!-- The next step in the process for this PR is learn how to <a href="http://docs.docker.com/project/review-pr/"
6059
target=_blank">participate in your PR's
61-
review </a>. -->
60+
review </a>. -->

opensource/kitematic/find_issue.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains how to find a Kitematic issue
3-
keywords:
4-
- Kitematic, open source, contribute, contributor, tour
3+
keywords: Kitematic, open source, contribute, contributor, tour
54
title: Find an issue on GitHub
65
---
76

@@ -41,4 +40,4 @@ To find and claim an issue you want to work on:
4140
Go to next section to learn [Set up your Kitematic development
4241
environment](set_up_dev.md).
4342

44-
(For more about working with open source issues in Docker, see <a href="/opensource/workflow/find-an-issue/" target="_blank">Find an issue</a> and <a href="https://github.com/docker/docker/blob/master/CONTRIBUTING.md" target="_blank"> Docker Contributing Guidelines</a>.)
43+
(For more about working with open source issues in Docker, see <a href="/opensource/workflow/find-an-issue/" target="_blank">Find an issue</a> and <a href="https://github.com/docker/docker/blob/master/CONTRIBUTING.md" target="_blank"> Docker Contributing Guidelines</a>.)

opensource/kitematic/get_started.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Overview of Kitematic development process
3-
keywords:
4-
- Kitematic, open source, contribute, contributor, tour, development
3+
keywords: Kitematic, open source, contribute, contributor, tour, development
54
title: Get started with your Kitematic contributions
65
---
76

@@ -32,4 +31,4 @@ the Kitematic codebase, this quick tour will help you get started. Follow along
3231

3332
## Where to go next
3433

35-
[Find an issue on GitHub](find_issue.md) to get started.
34+
[Find an issue on GitHub](find_issue.md) to get started.

opensource/kitematic/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Introduces Kitematic contribute topics and tour
3-
keywords:
4-
- Kitematic, open source, contribute, contributor, tour, issue, review
3+
keywords: Kitematic, open source, contribute, contributor, tour, issue, review
54
title: Contribute to Kitematic
65
---
76

@@ -10,4 +9,4 @@ title: Contribute to Kitematic
109
* [Set up for Kitematic development](set_up_dev.md)
1110
* [Develop in Kitematic (work on an issue)](work_issue.md)
1211
* [Review your branch and create a pull request (PR)](create_pr.md)
13-
* [Where to learn more](next_steps.md)
12+
* [Where to learn more](next_steps.md)

opensource/kitematic/next_steps.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
description: Explains next steps after the tour
3-
keywords:
4-
- Kitematic, open source, contribute, contributor, tour, development, contribute
5-
3+
keywords: Kitematic, open source, contribute, contributor, tour, development, contribute
64
title: Where to learn more
75
---
86

@@ -36,4 +34,4 @@ To learn more about contributing to Docker open source projects, see:
3634

3735
* <a href="/opensource/code/" target="_blank"> Quick Start contribution </a>
3836

39-
* <a href="/opensource/workflow/make-a-contribution/" target="_blank"> Understand how to contribute </a>
37+
* <a href="/opensource/workflow/make-a-contribution/" target="_blank"> Understand how to contribute </a>

opensource/kitematic/set_up_dev.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains how to find a Kitematic issue
3-
keywords:
4-
- Kitematic, open source, contribute, contributor, tour, development
3+
keywords: Kitematic, open source, contribute, contributor, tour, development
54
title: Set up for Kitematic development
65
---
76

@@ -179,4 +178,4 @@ The `components` folder is where the layout files are, the `stores` represent th
179178
## Where to go next
180179
181180
You are ready to start working on the issue. Go to [Develop in Kitematic (work
182-
on an issue)](work_issue.md).
181+
on an issue)](work_issue.md).

opensource/kitematic/work_issue.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains how to find a Kitematic issue
3-
keywords:
4-
- Kitematic, open source, contribute, contributor, tour, development
3+
keywords: Kitematic, open source, contribute, contributor, tour, development
54
title: Develop in Kitematic (work on an issue)
65
---
76

@@ -78,4 +77,4 @@ To do this, edit the container `General Settings` layout.
7877
7978
## Where to go next
8079
81-
At this point, you are ready to [Review your branch and create a pull request](create_pr.md) to merge your new feature into Kitematic.
80+
At this point, you are ready to [Review your branch and create a pull request](create_pr.md) to merge your new feature into Kitematic.

opensource/project/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describes Docker's communication channels
3-
keywords:
4-
- IRC, Google group, Twitter, blog, Stackoverflow
3+
keywords: IRC, Google group, Twitter, blog, Stackoverflow
54
title: Set up for Engine development
65
---
76

@@ -10,4 +9,4 @@ title: Set up for Engine development
109
* [Set up for development on Windows](software-req-win.md)
1110
* [Configure Git for contributing](set-up-git.md)
1211
* [Work with a development container](set-up-dev-env.md)
13-
* [Run tests and test documentation](test-and-docs.md)
12+
* [Run tests and test documentation](test-and-docs.md)

opensource/project/set-up-dev-env.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: How to use Docker's development environment
3-
keywords:
4-
- development, inception, container, image Dockerfile, dependencies, Go, artifacts
3+
keywords: development, inception, container, image Dockerfile, dependencies, Go, artifacts
54
title: Work with a development container
65
---
76

@@ -306,4 +305,4 @@ Congratulations, you have successfully achieved Docker inception. You've had a
306305
small experience of the develpment process. You've set up your development
307306
environment and verified almost all the essential processes you need to
308307
contribute. Of course, before you start contributing, [you'll need to learn one
309-
more piece of the development process, the test framework](test-and-docs.md).
308+
more piece of the development process, the test framework](test-and-docs.md).

opensource/project/set-up-git.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describes how to set up your local machine and repository
3-
keywords:
4-
- GitHub account, repository, clone, fork, branch, upstream, Git, Go, make
3+
keywords: GitHub account, repository, clone, fork, branch, upstream, Git, Go, make
54
title: Configure Git for contributing
65
---
76

@@ -282,4 +281,4 @@ commit is signed.
282281

283282
Congratulations, you have finished configuring both your local host environment
284283
and Git for contributing. In the next section you'll [learn how to set up and
285-
work in a Docker development container](set-up-dev-env.md).
284+
work in a Docker development container](set-up-dev-env.md).

opensource/project/software-req-win.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: How to set up a server to test Docker Windows client
3-
keywords:
4-
- development, inception, container, image Dockerfile, dependencies, Go, artifacts, windows
3+
keywords: development, inception, container, image Dockerfile, dependencies, Go, artifacts, windows
54
title: Get the required software for Windows
65
---
76

@@ -255,4 +254,4 @@ from GitHub.
255254
## Where to go next
256255

257256
In the next section, you'll [learn how to set up and configure Git for
258-
contributing to Docker](set-up-git.md).
257+
contributing to Docker](set-up-git.md).

opensource/project/software-required.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describes the software required to contribute to Docker
3-
keywords:
4-
- 'GitHub account, repository, Docker, Git, Go, make, '
3+
keywords: 'GitHub account, repository, Docker, Git, Go, make, '
54
title: Get the required software for Linux or macOS
65
---
76

@@ -100,4 +99,4 @@ You must log out and log back in for this modification to take effect.
10099
## Where to go next
101100

102101
In the next section, you'll [learn how to set up and configure Git for
103-
contributing to Docker](set-up-git.md).
102+
contributing to Docker](set-up-git.md).

opensource/project/test-and-docs.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describes Docker's testing infrastructure
3-
keywords:
4-
- make test, make docs, Go tests, gofmt, contributing, running tests
3+
keywords: make test, make docs, Go tests, gofmt, contributing, running tests
54
title: Run tests and test documentation
65
---
76

@@ -362,4 +361,4 @@ docs.docker.com, but you will be able to preview the changes.
362361
Congratulations, you have successfully completed the basics you need to
363362
understand the Docker test framework. In the next steps, you use what you have
364363
learned so far to [contribute to Docker by working on an
365-
issue](../workflow/make-a-contribution.md).
364+
issue](../workflow/make-a-contribution.md).

opensource/project/who-written-for.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: Introduction to project contribution at Docker
3+
keywords: Gordon, introduction, turtle, machine, libcontainer, how to
24
redirect_from:
35
- /project/who-written-for/
4-
description: Introduction to project contribution at Docker
5-
keywords:
6-
- Gordon, introduction, turtle, machine, libcontainer, how to
76
title: README first
87
---
98

@@ -59,4 +58,4 @@ Please feel free to skim past information you find obvious or boring.
5958

6059
Start by getting the software you require. If you are on Mac or Linux, go to
6160
[get the required software for Linux or macOS](software-required.md). If you are
62-
on Windows, see [get the required software for Windows](software-req-win.md).
61+
on Windows, see [get the required software for Windows](software-req-win.md).

opensource/ways/community.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Support the community
3-
keywords:
4-
- support, community, users, irc
3+
keywords: support, community, users, irc
54
title: Support the community
65
---
76

@@ -43,4 +42,4 @@ aspects of contributing. To help Docker contributors:
4342
</a> room
4443
* the <a href="https://groups.google.com/forum/#!forum/docker-dev"
4544
target="_blank">docker-dev</a> Google group
46-
* the `#docker-dev` channel on Freenode IRC
45+
* the `#docker-dev` channel on Freenode IRC

0 commit comments

Comments
 (0)