Skip to content

Commit

Permalink
fix type of keywords entry in frontmatter (in /opensource/)
Browse files Browse the repository at this point in the history
keywords should be a string, not an array containing one string

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
  • Loading branch information
gdevillele committed Nov 10, 2016
1 parent 3544131 commit b6b1ed1
Show file tree
Hide file tree
Showing 36 changed files with 75 additions and 112 deletions.
5 changes: 2 additions & 3 deletions opensource/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Overview of contributing
keywords:
- open, source, contributing, overview
keywords: open, source, contributing, overview
title: FAQ for contributors
---

Expand Down Expand Up @@ -136,4 +135,4 @@ force the previous change to be overwritten.
```
$ git push -f origin my-keen-feature
```
```
7 changes: 3 additions & 4 deletions opensource/code.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
description: Contribute code
keywords: governance, board, members, profiles
redirect_from:
- /contributing/contributing
description: Contribute code
keywords:
- governance, board, members, profiles
title: Quickstart code or doc contribution
---

Expand Down Expand Up @@ -77,4 +76,4 @@ pull request</a>.

7. <a href="http://docs.docker.com/opensource/workflow/review-pr/"
target="_blank">Participate in the pull request review</a> till a successful
merge.
merge.
5 changes: 2 additions & 3 deletions opensource/doc-style.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Style guide for Docker documentation describing standards and conventions for contributors
keywords:
- style, guide, docker, documentation
keywords: style, guide, docker, documentation
title: Documentation style and grammar conventions
---

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

Lastly, be sure you have permission to use any included graphics.
Lastly, be sure you have permission to use any included graphics.
5 changes: 2 additions & 3 deletions opensource/get-help.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Describes Docker's communication channels
keywords:
- IRC, Google group, Twitter, blog, Stackoverflow
keywords: IRC, Google group, Twitter, blog, Stackoverflow
title: Where to chat or get help
---

Expand Down Expand Up @@ -217,4 +216,4 @@ This quickstart was meant to get you up and into IRC very quickly. If you find
IRC useful there is more to learn. Drupal, another open source project,
has <a href="https://www.drupal.org/irc/setting-up" target="_blank">
written some documentation about using IRC</a> for their project
(thanks Drupal!).
(thanks Drupal!).
5 changes: 2 additions & 3 deletions opensource/governance/board-profiles.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Board member profiles
keywords:
- governance, board, members, profiles
keywords: governance, board, members, profiles
title: Board member profiles
---

Expand Down Expand Up @@ -62,4 +61,4 @@ and community of the Docker Project.
* Nicola Paolucci (Atlassian)
* Burke Libbey (Shopify)
* Meghdoot Bhattacharya (PayPal)
* Tapabrata Pal (Capital One)
* Tapabrata Pal (Capital One)
5 changes: 2 additions & 3 deletions opensource/governance/conduct-code.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Explains Docker's code of conduct
keywords:
- Docker, conduct, code
keywords: Docker, conduct, code
title: Code of conduct
---

Expand Down Expand Up @@ -37,4 +36,4 @@ maintainers.

This Code of Conduct is adapted from the [Contributor
Covenant](http://contributor-covenant.org), version 1.0.0, available at
[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
7 changes: 3 additions & 4 deletions opensource/governance/dgab-info.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
description: Docker Governance Advisory Board
keywords:
- governance, board, members, explained
title: "Docker Governance Advisory Board: June 2015 version"
keywords: governance, board, members, explained
title: 'Docker Governance Advisory Board: June 2015 version'
---

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

Please help us improve this draft by sending your comments and feedback to
[governance@docker.com](mailto:governance@docker.com).
[governance@docker.com](mailto:governance@docker.com).
5 changes: 2 additions & 3 deletions opensource/governance/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
description: Describes Docker's communication channels
keywords:
- IRC, Google group, Twitter, blog, Stackoverflow
keywords: IRC, Google group, Twitter, blog, Stackoverflow
title: Governance
---

* [Docker Governance Advisory Board](dgab-info.md )
* [Board member profiles](board-profiles.md )
* [Code of conduct](conduct-code.md)
* [Code of conduct](conduct-code.md)
5 changes: 2 additions & 3 deletions opensource/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Overview of contributing
keywords:
- open, source, contributing, overview
keywords: open, source, contributing, overview
title: Open Source at Docker
---

Expand All @@ -12,4 +11,4 @@ You also help the countless number of other project participants.
- [Configure the development environment](project/who-written-for.md) explains how to setup an environment to contribute to Docker engine.
- [Understand the contribution workflow ](workflow/make-a-contribution.md) explains the workflow the team uses across most Docker projects.
- [Other ways to contribute](ways/index.md) provides tips for contributing if you don't want to code.
- [Governance](governance/index.md) describes the proper conduct and who defines it.
- [Governance](governance/index.md) describes the proper conduct and who defines it.
5 changes: 2 additions & 3 deletions opensource/kitematic/create_pr.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Explains how to create a pull request for change or new feature
keywords:
- Kitematic, open source, contribute, contributor, tour, development, contribute, pull request, review, workflow, beginner, squash, commit
keywords: Kitematic, open source, contribute, contributor, tour, development, contribute, pull request, review, workflow, beginner, squash, commit
title: Create a pull request (PR)
---

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

<!-- The next step in the process for this PR is learn how to <a href="http://docs.docker.com/project/review-pr/"
target=_blank">participate in your PR's
review </a>. -->
review </a>. -->
5 changes: 2 additions & 3 deletions opensource/kitematic/find_issue.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Explains how to find a Kitematic issue
keywords:
- Kitematic, open source, contribute, contributor, tour
keywords: Kitematic, open source, contribute, contributor, tour
title: Find an issue on GitHub
---

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

(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>.)
(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>.)
5 changes: 2 additions & 3 deletions opensource/kitematic/get_started.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Overview of Kitematic development process
keywords:
- Kitematic, open source, contribute, contributor, tour, development
keywords: Kitematic, open source, contribute, contributor, tour, development
title: Get started with your Kitematic contributions
---

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

## Where to go next

[Find an issue on GitHub](find_issue.md) to get started.
[Find an issue on GitHub](find_issue.md) to get started.
5 changes: 2 additions & 3 deletions opensource/kitematic/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Introduces Kitematic contribute topics and tour
keywords:
- Kitematic, open source, contribute, contributor, tour, issue, review
keywords: Kitematic, open source, contribute, contributor, tour, issue, review
title: Contribute to Kitematic
---

Expand All @@ -10,4 +9,4 @@ title: Contribute to Kitematic
* [Set up for Kitematic development](set_up_dev.md)
* [Develop in Kitematic (work on an issue)](work_issue.md)
* [Review your branch and create a pull request (PR)](create_pr.md)
* [Where to learn more](next_steps.md)
* [Where to learn more](next_steps.md)
6 changes: 2 additions & 4 deletions opensource/kitematic/next_steps.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
description: Explains next steps after the tour
keywords:
- Kitematic, open source, contribute, contributor, tour, development, contribute

keywords: Kitematic, open source, contribute, contributor, tour, development, contribute
title: Where to learn more
---

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

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

* <a href="/opensource/workflow/make-a-contribution/" target="_blank"> Understand how to contribute </a>
* <a href="/opensource/workflow/make-a-contribution/" target="_blank"> Understand how to contribute </a>
5 changes: 2 additions & 3 deletions opensource/kitematic/set_up_dev.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Explains how to find a Kitematic issue
keywords:
- Kitematic, open source, contribute, contributor, tour, development
keywords: Kitematic, open source, contribute, contributor, tour, development
title: Set up for Kitematic development
---

Expand Down Expand Up @@ -179,4 +178,4 @@ The `components` folder is where the layout files are, the `stores` represent th
## Where to go next
You are ready to start working on the issue. Go to [Develop in Kitematic (work
on an issue)](work_issue.md).
on an issue)](work_issue.md).
5 changes: 2 additions & 3 deletions opensource/kitematic/work_issue.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Explains how to find a Kitematic issue
keywords:
- Kitematic, open source, contribute, contributor, tour, development
keywords: Kitematic, open source, contribute, contributor, tour, development
title: Develop in Kitematic (work on an issue)
---

Expand Down Expand Up @@ -78,4 +77,4 @@ To do this, edit the container `General Settings` layout.
## Where to go next
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.
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.
5 changes: 2 additions & 3 deletions opensource/project/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Describes Docker's communication channels
keywords:
- IRC, Google group, Twitter, blog, Stackoverflow
keywords: IRC, Google group, Twitter, blog, Stackoverflow
title: Set up for Engine development
---

Expand All @@ -10,4 +9,4 @@ title: Set up for Engine development
* [Set up for development on Windows](software-req-win.md)
* [Configure Git for contributing](set-up-git.md)
* [Work with a development container](set-up-dev-env.md)
* [Run tests and test documentation](test-and-docs.md)
* [Run tests and test documentation](test-and-docs.md)
5 changes: 2 additions & 3 deletions opensource/project/set-up-dev-env.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: How to use Docker's development environment
keywords:
- development, inception, container, image Dockerfile, dependencies, Go, artifacts
keywords: development, inception, container, image Dockerfile, dependencies, Go, artifacts
title: Work with a development container
---

Expand Down Expand Up @@ -306,4 +305,4 @@ Congratulations, you have successfully achieved Docker inception. You've had a
small experience of the develpment process. You've set up your development
environment and verified almost all the essential processes you need to
contribute. Of course, before you start contributing, [you'll need to learn one
more piece of the development process, the test framework](test-and-docs.md).
more piece of the development process, the test framework](test-and-docs.md).
5 changes: 2 additions & 3 deletions opensource/project/set-up-git.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Describes how to set up your local machine and repository
keywords:
- GitHub account, repository, clone, fork, branch, upstream, Git, Go, make
keywords: GitHub account, repository, clone, fork, branch, upstream, Git, Go, make
title: Configure Git for contributing
---

Expand Down Expand Up @@ -282,4 +281,4 @@ commit is signed.

Congratulations, you have finished configuring both your local host environment
and Git for contributing. In the next section you'll [learn how to set up and
work in a Docker development container](set-up-dev-env.md).
work in a Docker development container](set-up-dev-env.md).
5 changes: 2 additions & 3 deletions opensource/project/software-req-win.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: How to set up a server to test Docker Windows client
keywords:
- development, inception, container, image Dockerfile, dependencies, Go, artifacts, windows
keywords: development, inception, container, image Dockerfile, dependencies, Go, artifacts, windows
title: Get the required software for Windows
---

Expand Down Expand Up @@ -255,4 +254,4 @@ from GitHub.
## Where to go next

In the next section, you'll [learn how to set up and configure Git for
contributing to Docker](set-up-git.md).
contributing to Docker](set-up-git.md).
5 changes: 2 additions & 3 deletions opensource/project/software-required.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Describes the software required to contribute to Docker
keywords:
- 'GitHub account, repository, Docker, Git, Go, make, '
keywords: 'GitHub account, repository, Docker, Git, Go, make, '
title: Get the required software for Linux or macOS
---

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

In the next section, you'll [learn how to set up and configure Git for
contributing to Docker](set-up-git.md).
contributing to Docker](set-up-git.md).
5 changes: 2 additions & 3 deletions opensource/project/test-and-docs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Describes Docker's testing infrastructure
keywords:
- make test, make docs, Go tests, gofmt, contributing, running tests
keywords: make test, make docs, Go tests, gofmt, contributing, running tests
title: Run tests and test documentation
---

Expand Down Expand Up @@ -362,4 +361,4 @@ docs.docker.com, but you will be able to preview the changes.
Congratulations, you have successfully completed the basics you need to
understand the Docker test framework. In the next steps, you use what you have
learned so far to [contribute to Docker by working on an
issue](../workflow/make-a-contribution.md).
issue](../workflow/make-a-contribution.md).
7 changes: 3 additions & 4 deletions opensource/project/who-written-for.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
description: Introduction to project contribution at Docker
keywords: Gordon, introduction, turtle, machine, libcontainer, how to
redirect_from:
- /project/who-written-for/
description: Introduction to project contribution at Docker
keywords:
- Gordon, introduction, turtle, machine, libcontainer, how to
title: README first
---

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

Start by getting the software you require. If you are on Mac or Linux, go to
[get the required software for Linux or macOS](software-required.md). If you are
on Windows, see [get the required software for Windows](software-req-win.md).
on Windows, see [get the required software for Windows](software-req-win.md).
5 changes: 2 additions & 3 deletions opensource/ways/community.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Support the community
keywords:
- support, community, users, irc
keywords: support, community, users, irc
title: Support the community
---

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

0 comments on commit b6b1ed1

Please sign in to comment.