Skip to content

Commit

Permalink
Merge pull request docker#603 from londoncalling/vnext-compose-1.9.0-…
Browse files Browse the repository at this point in the history
…merge

Vnext compose 1.9.0 merge
  • Loading branch information
londoncalling authored Nov 16, 2016
2 parents b822a91 + b2eb693 commit 272849d
Show file tree
Hide file tree
Showing 1,124 changed files with 81,271 additions and 9,012 deletions.
31 changes: 0 additions & 31 deletions .NOT_EDITED_HERE.txt

This file was deleted.

1 change: 1 addition & 0 deletions .NOT_EDITED_HERE.yaml
50 changes: 45 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
20 changes: 8 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,29 @@
<!--Thanks for your contribution. See [CONTRIBUTING](CONTRIBUTING.md)
for this project's contribution guidelines. -->

<!--DO NOT edit files and directories listed in .NOT_EDITED_HERE.txt.
<!--DO NOT edit files and directories listed in .NOT_EDITED_HERE.yaml.
These are maintained in upstream repos and changes here will be lost.-->

### Describe the proposed changes

<!-- Tell us what you did and why. You can leave this off if the PR title
is descriptive. The commit message will be added to the end of this form.-->
<!-- Tell us what you did and why.-->

### Project version
### Unreleased project version

<!-- If this change only applies to a future version of a project (like
Docker Engine 1.13), note that here and base your work on the `vnext-`
branch for your project. -->
<!-- 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, or 'Fixes #1234' or 'Closes #1234'. -->
<!-- Refer to related PRs or issues: #1234, or 'Fixes #1234' or 'Closes #1234'. -->

### Related issue or PR in another project

<!-- Links to issues or pull requests in other repositories if applicable. -->
<!-- Full URLs to issues or pull requests in other Github projects -->

### Please take a look

<!-- At-mention specific individuals or groups 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. -->
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.3.1
6 changes: 3 additions & 3 deletions 404.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -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
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -93,8 +101,17 @@ 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 three options:

Expand All @@ -107,7 +124,7 @@ You have three options:
```

If you haven't got Docker Compose installed,
[follow these installation instructions](/compose/install/).
[follow these installation instructions](https://docs.docker.com/compose/install/).
The container runs in the background and incrementally rebuilds the site each
time a file changes. You can keep your browser open to http://localhost:4000/
Expand Down Expand Up @@ -150,7 +167,7 @@ directly on docs.docker.com.
## Style guide
If you have questions about how to write for Docker's documentation, please see
the [style guide](/opensource/doc-style/). The style guide provides
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.
Expand Down
99 changes: 96 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,111 @@ url: https://docs.docker.com

gems:
- jekyll-redirect-from
- jekyll-gist
- jekyll-seo-tag

webrick:
headers:
Cache-Control: 600

defaults:
-
scope:
path: ""
type: "pages"
values:
layout: docs
archiveserver: "http://54.71.194.30"
defaultassignee: johndmulhausen
- scope:
path: "compose"
values:
assignee: "londoncalling"
- scope:
path: "cs-engine"
values:
assignee: "joaofnfernandes"
- scope:
path: "datacenter"
values:
assignee: "joaofnfernandes"
- scope:
path: "docker-cloud"
values:
assignee: "sanscontext"
- scope:
path: "docker-for-mac"
values:
assignee: "londoncalling"
- scope:
path: "docker-for-windows"
values:
assignee: "londoncalling"
- scope:
path: "docker-hub"
values:
assignee: "sanscontext"
- scope:
path: "docker-store"
values:
assignee: "johndmulhausen"
- scope:
path: "engine"
values:
assignee: "mstanleyjones"
- scope:
path: "kitematic"
values:
assignee: "londoncalling"
- scope:
path: "machine"
values:
assignee: "londoncalling"
- scope:
path: "notary"
values:
assignee: "johndmulhausen"
- scope:
path: "registry"
values:
assignee: "joaofnfernandes"
- scope:
path: "swarm"
values:
assignee: "mstanleyjones"
- scope:
path: "toolbox"
values:
assignee: "londoncalling"
-
scope:
path: "datacenter/dtr/2.0"
values:
hide_from_sitemap: true
this_version: "2.0"
latest_version: "2.1"
-
scope:
path: "datacenter/ucp/1.1"
values:
hide_from_sitemap: true
this_version: "1.1"
latest_version: "2.0"
-
scope:
path: "apidocs/v1.3.3"
values:
hide_from_sitemap: true
-
scope:
path: "apidocs/v1.4.0"
values:
hide_from_sitemap: true
-
scope:
path: "apidocs/v2.0.0"
values:
hide_from_sitemap: true
-
scope:
path: "apidocs/v2.0.1"
values:
hide_from_sitemap: true
38 changes: 38 additions & 0 deletions _data/.NOT_EDITED_HERE.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Files and directories here are not edited in the docker.github.io repo.
# Instead, they are edited in the appropriate upstream repo and pulled
# into this repo periodically, or they are automatically generated. The intent
# is that if you submit a PR with changes to these files or directories, a CI
# job will fail in the PR, indicating that it should not be merged. THIS IS NOT
# YET IMPLEMENTED!! The PR reviewer should make sure no files here are in the PR.

# If you need to edit these files or directories, submit a PR in the repo and
# directory listed in "source" below.

# Make sure directories have the trailing slash, keep the list alphabetical

- path: apidocs/
description: "Auto-generated API docs for Docker Cloud, DTR, UCP. File an issue."

- path: engine/deprecated.md
description: Docker Engine deprecation reference
source: https://github.com/docker/docker/docs/deprecated.md

- path: engine/extend/
description: References for Docker Engine plugin system
source: https://github.com/docker/docker/docs/extend/

- path: engine/reference/
description: Docker Engine CLI and API references
source: https://github.com/docker/docker/docs/reference/

- path: notary/reference/
description: Reference docs for Docker Notary
source: https://github.com/docker/notary/docs/reference/

- path: registry/configuration.md
description: Reference docs for configuring Docker Registry
source: https://github.com/docker/distribution/docs/configuration.md

- path: registry/spec/
description: Docker Registry API references
source: https://github.com/docker/distribution/docs/spec/
Empty file added _data/docsarchive/archive.yml
Empty file.
Loading

0 comments on commit 272849d

Please sign in to comment.