Merge branch 'master' into patch-1

.NOT_EDITED_HERE.yaml

@@ -0,0 +1 @@
+_data/.NOT_EDITED_HERE.yaml

.github/CONTRIBUTING.md

@@ -9,6 +9,14 @@ let you know so that you can rebase it.
 >**Note**: To contribute code to Docker projects, see the
 [Contribution guidelines](opensource/project/who-written-for).
 
+### Files not edited here
+
+Files and directories listed in the `path:` keys in
+[`.NOT_EDITED_HERE.yaml`](/NOT_EDITED_HERE.yaml) are maintained in other
+repositories and should not be edited in this one. Pull requests against these
+files will be rejected. Make your edits to the files in the repository and path
+in the `source:` key in the YAML file.
+
 ### Quickstart
 
 If you spot a problem while reading the documentation and want to try to fix it
@@ -79,10 +87,42 @@ The following `vnext` branches currently exist:
   docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
   project
 
+## Collaborate on a pull request
+
+Unless the PR author specifically disables it, you can push commits into another
+contributor's PR. You can do it from the command line by adding and fetching
+their remote, checking out their branch, and adding commits to it. Even easier,
+you can add commits from the Github web UI, by clicking the pencil icon for a
+given file in the **Files** view.
+
+If a PR consists of multiple small addendum commits on top of a more significant
+one, the commit will usually be "squash-merged", so that only one commit is
+merged in. On occasion this is not appropriate and all commits will be kept
+separate when merging.
+
+## Pull request guidelines
+
+Help us review your PRs more quickly by following these guidelines.
+
+- Try not to touch a large number of files in a single PR if possible.
+
+- Don't change whitespace or line wrapping in parts of a file you are not
+  editing for other reasons. Make sure your text editor is not configured to
+  automatically reformat the whole file when saving.
+
+- A Netlify test runs for each PR that is against one of our long-lived
+  branches like `master` and the `vnext` branches, and deploys the result of
+  your PR to a staging site. The URL will be available at the bottom of the PR
+  in the **Conversation** view. Check the staging site for problems and fix them
+  if necessary. Reviewers will check the staging site too.
+
+If you can think of other ways we could streamline the review process, let us
+know.
+
 ## Style guide
 
-If you have questions about how to write for Docker's documentation, please see
-the [style guide](https://docs.docker.com/opensource/doc-style/). The style guide provides
-guidance about grammar, syntax, formatting, styling, language, or tone. If
-something isn't clear in the guide, please submit an issue to let us know or
-submit a pull request to help us improve it.
+If you have questions about how to write for Docker's documentation, have a look
+at the [style guide](https://docs.docker.com/opensource/doc-style/). The style
+guide provides guidance about grammar, syntax, formatting, styling, language, or
+tone. If something isn't clear in the guide, please submit an issue to let us
+know or submit a pull request to help us improve it.

.github/ISSUE_TEMPLATE.md

@@ -1,40 +1,26 @@
 ### Problem description
 
-<!-- Provide a brief description of the problem with
-the documentation.
-
-If this is an issue with Docker itself, rather than
-the Docker documentation, this may not be the right
-place to file the issue. Consider filing it in the
-specific project's repository or asking a question
-on forums.docker.com.
-
-You can delete these comments as you are filling out
-the template. -->
+<!-- Briefly describe the problem that you found. Only documentation issues should be filed here. 
+     For general questions, go to https://forums.docker.com/. -->
 
 ### Problem location
 
-<!-- Help us find the problem quickly by choosing one
-     of these. Put an x between the brackets of your
-     choice, like [x]. -->
+<!-- Help us find the problem quickly by choosing one of these. -->
 
-- [ ] I saw the problem on the following URL:
+- I saw a problem on the following URL: <URL>
 
-- [ ] I couldn't find the information I wanted. I expected to find it near the following URL:
+- I couldn't find the information I wanted. I expected to find it near the following URL: <URL>
 
-- [ ] Other:
+- Other: <DETAILS>
 
 ### Project version(s) affected
 
-<!-- If this problem only affects specific versions of a
-project (like Docker Engine 1.13), mention it here. The fix
-may need to take that into account. -->
+<!-- If this problem only affects specific versions of a project (like Docker
+     Engine 1.13), tell us here. The fix may need to take that into account. -->
 
 ### Suggestions for a fix
 
-<!--If you have specific ideas for how the problem
-can be addressed, let us know.-->
-
+<!--If you have specific ideas about how we can fix this, let us know. -->
 
 
 <!-- To improve this template, edit the .github/ISSUE_TEMPLATE.md file -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,52 +1,29 @@
-<!--Thanks for your contribution. Please use the following
-guidelines to help us review it. You can remove these comments
-as you fill out this template. -->
-
-<!--DO NOT edit files and directories listed in .NOT_EDITED_HERE.txt
-as these are maintained in upstream repos and added to the central
-docs repo periodically. Your PR will fail automated checks if it
-includes changes to these files or directories.-->
-
-<!-- **Squash your commits**: Please use an
-interactive rebase (https://help.github.com/articles/about-git-rebase/)
-to squash (combine) multiple commits into a single commit, to keep the
-commit history clean. The exception is when commits from multiple
-contributors exist in the same pull request. In that case, one commit
-per contributor is preferred, to keep the history clean but also give
-credit for the work to all contributors. -->
+<!--Thanks for your contribution. See [CONTRIBUTING](CONTRIBUTING.md)
+    for this project's contribution guidelines. -->
 
-### Describe the proposed changes
+<!--DO NOT edit files and directories listed in .NOT_EDITED_HERE.yaml.
+    These are maintained in upstream repos and changes here will be lost.-->
 
-<!-- Tell us what you did and why. You can leave this off if
-the PR title is descriptive. -->
+### Describe the proposed changes
 
-### Project version
+<!-- Tell us what you did and why.-->
 
-<!-- If this change only applies to a certain version of a project
-(like Docker Engine 1.13), note that here. Also, consider adding
-that info to the docs in your change, such as by adding
-"In Docker 1.13 and higher..." or similar. -->
+### Unreleased project version
 
-<!-- Also, DO NOT base your work on master if your change is only
-relevant to an unreleased version of a project. Instead, base
-your work on the `vnext-<PROJECT>` branch, which will be merged
-into master when that project has a new release.-->
+<!-- If this change only applies to an unreleased version of a project, note
+     that here and base your work on the `vnext-` branch for your project. -->
 
 ### Related issue
 
-<!-- If this relates to an issue or PR in this repo, refer to it
-like #1234 -->
+<!-- Refer to related PRs or issues: #1234, or 'Fixes #1234' or 'Closes #1234'. -->
 
 ### Related issue or PR in another project
 
-<!-- Provide one or more links to issues or pull requests in
-other repositories. For instance, a link to the PR that
-introduces a code change that this PR is documenting. -->
+<!-- Full URLs to issues or pull requests in other Github projects -->
 
 ### Please take a look
 
-<!-- Use this section to at-mention specific individuals who should take a
-look at this PR. For instance, @exampleuser123-->
+<!-- At-mention specific individuals or groups, like @exampleuser123 -->
 
 
 <!-- To improve this template, edit .github/PULL_REQUEST_TEMPLATE.md. -->

.ruby-version

@@ -0,0 +1 @@
+2.3.1

404.md

@@ -22,14 +22,14 @@ if (forwardingURL.indexOf(".md") > -1)
 
   // DOCS ARCHIVE CHECK
 {% for item in site.data.docsarchive.docker-compose %}
-  if (forwardingURL.indexOf("/{{ item[0] }}") > -1)
+  if (forwardingURL == "/{{ item[0] }}/")
   {
     console.log("Found via Docker Compose file for Acrhive")
     gonnaFwd = true;
     archive = true;
     // make it so redirects cascade; first, use the base URL, then append path
-    baseURL = "{{ page.archiveserver }}:{{ item[1].ports[0] | replace:':4000','' }}";
-    newURL = forwardingURL.replace("/{{ item[0] }}","");
+    baseURL = "{{ site.url }}";
+    newURL = forwardingURL;
   }{% endfor %}
 
 if (archive==false) {

Dockerfile

@@ -1,9 +1,88 @@
-FROM starefossen/github-pages:onbuild
+FROM starefossen/github-pages
 
-ONBUILD RUN git clone https://www.github.com/docker/docker.github.io docs
+# Basic Git set-up for throwaway commits
+RUN git config --global user.email "[email protected]"
+RUN git config --global user.name "Gordon"
 
-ONBUILD WORKDIR docs
+# Clone the docs repo
+RUN git clone https://www.github.com/docker/docker.github.io allv
 
-ONBUILD COPY . /usr/src/app
+# Get docker/docker ref docs from 1.12.x branch to be used in master builds
+# Uses Github Subversion gateway to limit the checkout
+RUN svn co https://github.com/docker/docker/branches/1.12.x/docs/reference allv/engine/reference
+RUN svn co https://github.com/docker/docker/branches/1.12.x/docs/extend allv/engine/extend
+# Can't use the svn trick to get a single file, use wget instead
+RUN wget -O allv/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/1.12.x/docs/deprecated.md
+# Make a temporary commit for the files we added so we can check out other branches later
+RUN git --git-dir=./allv/.git --work-tree=./allv add engine
+RUN git --git-dir=./allv/.git --work-tree=./allv commit -m "Temporary commit"
 
-CMD jekyll serve -d /_site --watch -H 0.0.0.0 -P 4000
+# Create HTML for master
+RUN jekyll build -s allv -d allvbuild
+
+# Check out 1.4 branch, create HTML, tweak links
+RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.4
+RUN mkdir allvbuild/v1.4
+RUN jekyll build -s allv -d allvbuild/v1.4
+RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.4/#g'
+RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.4/#g'
+RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.4/#g'
+
+# Check out 1.5 branch, create HTML, tweak links
+RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.5
+RUN mkdir allvbuild/v1.5
+RUN jekyll build -s allv -d allvbuild/v1.5
+RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.5/#g'
+RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.5/#g'
+RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.5/#g'
+
+# Check out 1.6, create HTML, tweak links
+RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.6
+RUN mkdir allvbuild/v1.6
+RUN jekyll build -s allv -d allvbuild/v1.6
+RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.6/#g'
+RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.6/#g'
+RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.6/#g'
+
+# Check out 1.7, create HTML, tweak links
+RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.7
+RUN mkdir allvbuild/v1.7
+RUN jekyll build -s allv -d allvbuild/v1.7
+RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.7/#g'
+RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.7/#g'
+RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.7/#g'
+
+# Check out 1.8, create HTML, tweak links
+RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.8
+RUN mkdir allvbuild/v1.8
+RUN jekyll build -s allv -d allvbuild/v1.8
+RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.8/#g'
+RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.8/#g'
+RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.8/#g'
+
+# Check out 1.9, create HTML, tweak links
+RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.9
+RUN mkdir allvbuild/v1.9
+RUN jekyll build -s allv -d allvbuild/v1.9
+RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.9/#g'
+RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.9/#g'
+RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.9/#g'
+
+# Check out 1.10, create HTML, tweak links
+RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.10
+RUN mkdir allvbuild/v1.10
+RUN jekyll build -s allv -d allvbuild/v1.10
+RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.10/#g'
+RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.10/#g'
+RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.10/#g'
+
+# Check out 1.11, create HTML, tweak links
+RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.11
+RUN mkdir allvbuild/v1.11
+RUN jekyll build -s allv -d allvbuild/v1.11
+RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.11/#g'
+RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.11/#g'
+RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.11/#g'
+
+# Serve the site, which is now all static HTML
+CMD jekyll serve -s /usr/src/app/allvbuild -d /_site --no-watch -H 0.0.0.0 -P 4000

Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "github-pages", "104" #Update me once in a while: https://github.com/github/pages-gem/releases

README.md

@@ -32,7 +32,15 @@ help. If a reviewer realizes you have based your work on the wrong branch, we'll
 let you know so that you can rebase it.
 
 >**Note**: To contribute code to Docker projects, see the
-[Contribution guidelines](opensource/project/who-written-for).
+[Contribution guidelines](https://docs.docker.com/opensource/project/who-written-for/).
+
+### Files not edited here
+
+Files and directories listed in the `path:` keys in
+[`.NOT_EDITED_HERE.yaml`](.NOT_EDITED_HERE.yaml) are maintained in other
+repositories and should not be edited in this one. Pull requests against these
+files will be rejected. Make your edits to the files in the repository and path
+in the `source:` key in the YAML file.
 
 ### Overall doc improvements
 
@@ -93,10 +101,19 @@ The following `vnext` branches currently exist:
   docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
   project
 
+## Per-PR staging on Github
+
+For every PR against `master` and all the long-lived branches, a staged version
+of the site is built using Netlify. If the site builds, you will see
+**deploy/netlify — Deploy preview ready**. Otherwise, you will see an error.
+Click **Details** to review the staged site or the errors that prevented it from
+building. Review the staged site and amend your commit if necessary. Reviewers
+will also check the staged site before merging the PR, to protect the integrity
+of [docs.docker.com](http://docs.docker.com/).
 
-## Staging
+## Staging locally
 
-You have two options:
+You have three options:
 
 1.  Clone this repo and run our staging container: