From 669b51a88994802f6676010d90298427f2c5ddef Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Tue, 28 Mar 2017 16:42:44 -0700 Subject: [PATCH] Fix broken links (#2521) --- _data/toc.yaml | 2 + compose/compose-file/index.md | 2 +- cs-engine/1.12/release-notes/release-notes.md | 4 +- .../reference/commandline/plugin_upgrade.md | 13 ++++++ machine/get-started.md | 2 +- notary/advanced_usage.md | 9 ++-- opensource/project/test-and-docs.md | 4 +- opensource/workflow/review-pr.md | 42 ++++++++++--------- 8 files changed, 48 insertions(+), 30 deletions(-) create mode 100644 engine/reference/commandline/plugin_upgrade.md diff --git a/_data/toc.yaml b/_data/toc.yaml index 9f9b866ed1..812a3ba124 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -701,6 +701,8 @@ reference: title: docker plugin rm - path: /engine/reference/commandline/plugin_set/ title: docker plugin set + - path: /engine/reference/commandline/plugin_upgrade/ + title: docker plugin upgrade - path: /engine/reference/commandline/port/ title: docker port - path: /engine/reference/commandline/ps/ diff --git a/compose/compose-file/index.md b/compose/compose-file/index.md index e2d868563a..0ef84cbf2d 100644 --- a/compose/compose-file/index.md +++ b/compose/compose-file/index.md @@ -37,7 +37,7 @@ tutorial](/engine/getstarted-voting-app/index.md).
diff --git a/cs-engine/1.12/release-notes/release-notes.md b/cs-engine/1.12/release-notes/release-notes.md index 4995bb4f59..baf4c36fac 100644 --- a/cs-engine/1.12/release-notes/release-notes.md +++ b/cs-engine/1.12/release-notes/release-notes.md @@ -30,8 +30,8 @@ CS Engine. For notes on older versions, see the [CS Engine prior release notes a ## CS Engine 1.12.6-cs9 (28 Feb 2017) -* Fixes an issue causing containerd to deadlock [#336](github.com/docker/containerd/pull/336) -* Fixes an issue where encrypted overlay networks stop working [#30727](github.com/docker/docker/issues/30727) +* Fixes an issue causing containerd to deadlock [#336](https://github.com/docker/containerd/pull/336) +* Fixes an issue where encrypted overlay networks stop working [#30727](https://github.com/docker/docker/issues/30727) ## CS Engine 1.12.6-cs8 (8 Feb 2017) diff --git a/engine/reference/commandline/plugin_upgrade.md b/engine/reference/commandline/plugin_upgrade.md new file mode 100644 index 0000000000..b97ae59951 --- /dev/null +++ b/engine/reference/commandline/plugin_upgrade.md @@ -0,0 +1,13 @@ +--- +datafolder: engine-cli +datafile: docker_plugin_upgrade +title: docker plugin upgrade +--- + +{% include cli.md %} diff --git a/machine/get-started.md b/machine/get-started.md index aea08a22da..be73623fc6 100644 --- a/machine/get-started.md +++ b/machine/get-started.md @@ -73,7 +73,7 @@ Toolbox. * Make sure you have [the latest VirtualBox](https://www.virtualbox.org/wiki/Downloads){: target="_blank" class="_"} correctly installed on your system. If you used - [Toolbox]("https://www.docker.com/products/docker-toolbox"){: target="_blank" class="_"} + [Toolbox](https://www.docker.com/products/docker-toolbox){: target="_blank" class="_"} or [Docker for Windows](/docker-for-windows/index.md){: target="_blank" class="_"} to install Docker Machine, VirtualBox is automatically installed. diff --git a/notary/advanced_usage.md b/notary/advanced_usage.md index 026489e5a3..20fa99ff5c 100644 --- a/notary/advanced_usage.md +++ b/notary/advanced_usage.md @@ -98,15 +98,14 @@ The targets key must be locally managed - to rotate the targets key, for instanc ### Use a Yubikey Notary can be used with -Yubikey -4 keys, via a PKCS11 interface when the Yubikey has CCID mode enabled. +[Yubikey 4](https://www.yubico.com/products/yubikey-hardware/yubikey4/){: target="_blank" class="_"} +keys, via a PKCS11 interface when the Yubikey has CCID mode enabled. The Yubikey will be prioritized to store root keys, and will require user touch-input for signing. Note that Yubikey support is included with the Docker Engine 1.11 client for use with Docker Content Trust. Yubikey support requires -Yubico PIV libraries -(which are bundled with the PIV tools) to be available in standard -library locations. +[Yubico PIV libraries](https://www.yubico.com/support/knowledge-base/categories/downloads/){: target="_blank" class="_"} +(bundled with the PIV tools) to be available in standard library locations. ## Work with delegation roles diff --git a/opensource/project/test-and-docs.md b/opensource/project/test-and-docs.md index a8cb35b007..ad06df7037 100644 --- a/opensource/project/test-and-docs.md +++ b/opensource/project/test-and-docs.md @@ -242,7 +242,7 @@ make any changes, just run these commands again. The Docker documentation source files are in a centralized repository at [https://github.com/docker/docker.github.io](https://github.com/docker/docker.github.io). The content is -written using extended Markdown, which you can edit in a plain text editor such as +written using extended Markdown, which you can edit in a plain text editor such as Atom or Notepad. The docs are built using [Jekyll](https://jekyllrb.com/). Most documentation is developed in the centralized repository. The exceptions are @@ -282,7 +282,7 @@ which will build an image named `docs/docstage` and launch a container with Jeky correctly. The container uses Jekyll to incrementally build and serve the site using the files in the local repository. -Go to [http://localhost:4000/](http://localhost:4000/) in your web browser to view the documentation. +Go to `http://localhost:4000/` in your web browser to view the documentation. The container runs in the foreground. It will continue to run and incrementally build the site when changes are detected, even if you change branches. diff --git a/opensource/workflow/review-pr.md b/opensource/workflow/review-pr.md index 8d445b671d..7924c7a32b 100644 --- a/opensource/workflow/review-pr.md +++ b/opensource/workflow/review-pr.md @@ -12,6 +12,10 @@ The CI system is an automated system. The maintainers are human beings that also work on Docker. You need to understand and work with both the "bots" and the "beings" to review your contribution. +> **Note**: These guidelines apply to Docker code submissions. If you want to +> contribute to the Docker documentation itself, see the guidelines in the +> `docker.github.io` repository's +> [README.md](https://github.com/docker/docker.github.io). ## How we process your review @@ -28,19 +32,21 @@ code. Building includes running the same tests you ran locally. If you forgot to run tests or missed something in fixing problems, the automated build is our safety check. -After Gordon and the bots, the "beings" review your work. Docker maintainers look -at your pull request and comment on it. The shortest comment you might see is -`LGTM` which means **l**ooks-**g**ood-**t**o-**m**e. If you get an `LGTM`, that -is a good thing, you passed that review. +After Gordon and the bots, Docker maintainers look at your pull request and +provide feedback. The shortest comment you might see is `LGTM` which means +"Looks Good To Me". If you get an `LGTM`, that is a good thing, you passed that +review. For complex changes, maintainers may ask you questions or ask you to change -something about your submission. All maintainer comments on a PR go to the -email address associated with your GitHub account. Any GitHub user who -"participates" in a PR receives an email to. Participating means creating or -commenting on a PR. +something about your submission. You are notified about all maintainer comments +on a PR, depending on the way you have configured Github to notify you. Any +GitHub user who participates in a PR receives an email. Participation includes +creating the PR, commenting on it, committing into someone else's PR, or being +at-mentioned in a comment. You can unsubscribe from notifications to a PR by +clicking the **Unsubscribe** button. -Our maintainers are very experienced Docker users and open source contributors. -So, they value your time and will try to work efficiently with you by keeping +Our maintainers are experienced Docker users and open source contributors. +They value your time and will try to work efficiently with you by keeping their comments specific and brief. If they ask you to make a change, you'll need to update your pull request with additional changes. @@ -48,7 +54,7 @@ need to update your pull request with additional changes. To update your existing pull request: -1. Checkout the PR branch in your local `docker-fork` repository. +1. Checkout the PR branch in your local repository. This is the branch associated with your request. @@ -79,9 +85,10 @@ To update your existing pull request: # modified: docs/installation/mac.md # modified: docs/installation/rhel.md -5. Force push the change to your origin. +5. Force-push the change to your origin. - The command syntax is: + Force-pushing is necessary because you amended your commit, and effectively + changed history. The command syntax is: git push -f origin @@ -107,7 +114,7 @@ It can take time to see a merged pull request in Docker's official release. A master build is available almost immediately though. Docker builds and updates its development binaries after each merge to `master`. -1. Browse to https://master.dockerproject.org/. +1. Browse to [https://master.dockerproject.org/](https://master.dockerproject.org/){: target="_blank" class="_"}. 2. Look for the binary appropriate to your system. @@ -116,12 +123,9 @@ updates its development binaries after each merge to `master`. You might want to run the binary in a container though. This will keep your local host environment clean. -4. View any documentation changes at docs.master.dockerproject.org. - Once you've verified everything merged, feel free to delete your feature branch -from your fork. For information on how to do this, - -see the GitHub help on deleting branches. +from your fork. +[See the GitHub help on deleting branches](https://help.github.com/articles/deleting-unused-branches/){: target="_blank" class="_"}. ## Where to go next