Skip to content

Commit

Permalink
Merge pull request docker#427 from mstanleyjones/vnext-engine
Browse files Browse the repository at this point in the history
Merge master into vnext engine
  • Loading branch information
johndmulhausen committed Nov 4, 2016
2 parents 56b204a + c8dab50 commit 9679c9f
Show file tree
Hide file tree
Showing 387 changed files with 6,425 additions and 6,836 deletions.
31 changes: 31 additions & 0 deletions .NOT_EDITED_HERE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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. 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.

# If you need to edit these files or directories, submit a PR in one of the
# following repos. The file will probably be located within the docs/ subdirectory.

# docker-trusted-registry: n/a, file an issue
# engine: https://github.com/docker/docker
# compose: https://github.com/docker/compose
# notary: https://github.com/docker/notary
# registry: https://github.com/docker/distribution
# swarm: https://github.com/docker/swarm
# ucp: n/a, file an issue

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

apidocs/
compose/reference/
docker-trusted-registry/reference/
engine/deprecated.md
engine/extend/
engine/reference/
machine/reference/
notary/reference/
registry/configuration.md
registry/spec/
swarm/reference/
ucp/reference/
3 changes: 0 additions & 3 deletions .arcconfig

This file was deleted.

6 changes: 0 additions & 6 deletions .babelrc

This file was deleted.

5 changes: 0 additions & 5 deletions .bumpversion.cfg

This file was deleted.

1 change: 0 additions & 1 deletion .dockercfg.template

This file was deleted.

21 changes: 0 additions & 21 deletions .drone.yml

This file was deleted.

29 changes: 0 additions & 29 deletions .editorconfig

This file was deleted.

14 changes: 0 additions & 14 deletions .flowconfig

This file was deleted.

88 changes: 88 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
## Contributing

We value your documentation contributions, and we want to make it as easy
as possible to work in this repository. One of the first things to decide is
which branch to base your work on. If you get confused, just ask and we will
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).

### Quickstart

If you spot a problem while reading the documentation and want to try to fix it
yourself, click the **Edit this page** link at the bottom of that page. The
page will open in the Github editor, which means you don't need to know a lot
about Git, or even about Markdown.

When you save, you will be prompted to create a fork if you don't already have
one, and to create a branch in your fork and submit the pull request. We hope
you give it a try!

### Overall doc improvements

Most commits will be made against the `master` branch. This include:

- Conceptual and task-based information not specific to new features
- Restructuring / rewriting
- Doc bug fixing
- Typos and grammar errors

One quirk of this project is that the `master` branch is where the live docs are
published from, so upcoming features can't be documented there. See
[Specific new features for a project](#specific-new-features-for-a-project)
for how to document upcoming features. These feature branches will be periodically
merged with `master`, so don't worry about fixing typos and documentation bugs
there.

>Do you enjoy creating graphics? Good graphics are key to great documentation,
and we especially value contributions in this area.

### Specific new features for a project

Our docs cover many projects which release at different times. **If, and only if,
your pull request relates to a currently unreleased feature of a project, base
your work on that project's `vnext` branch.** These branches were created by
cloning `master` and then importing a project's `master` branch's docs into it
(at the time of the migration), in a way that preserved the commit history. When
a project has a release, its `vnext` branch will be merged into `master` and your
work will be visible on docs.docker.com.

The following `vnext` branches currently exist:

- **[vnext-engine](https://github.com/docker/docker.github.io/tree/vnext-engine):**
docs for upcoming features in the [docker/docker](https://github.com/docker/docker/)
project

- **[vnext-compose](https://github.com/docker/docker.github.io/tree/vnext-compose):**
docs for upcoming features in the [docker/compose](https://github.com/docker/compose/)
project

- **[vnext-distribution](https://github.com/docker/docker.github.io/tree/vnext-distribution):**
docs for upcoming features in the [docker/distribution](https://github.com/docker/distribution/)
project

- **[vnext-opensource](https://github.com/docker/docker.github.io/tree/vnext-opensource):**
docs for upcoming features in the [docker/opensource](https://github.com/docker/opensource/)
project

- **[vnext-swarm](https://github.com/docker/docker.github.io/tree/vnext-swarm):**
docs for upcoming features in the [docker/swarm](https://github.com/docker/swarm/)
project

- **[vnext-toolbox](https://github.com/docker/docker.github.io/tree/vnext-toolbox):**
docs for upcoming features in the [docker/toolbox](https://github.com/docker/toolbox/)
project

- **[vnext-kitematic](https://github.com/docker/docker.github.io/tree/vnext-kitematic):**
docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
project

## 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.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
### Problem description

<!-- 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. -->

- 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: <URL>

- Other: <DETAILS>

### Project version(s) affected

<!-- 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 about how we can fix this, let us know. -->


<!-- To improve this template, edit the .github/ISSUE_TEMPLATE.md file -->
33 changes: 33 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!--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.
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.-->

### 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. -->

### Related issue

<!-- If this relates to an issue or PR in this repo, refer to it like
#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. -->

### Please take a look

<!-- At-mention specific individuals or groups who should take a
look at this PR. For instance, @exampleuser123 -->


<!-- To improve this template, edit .github/PULL_REQUEST_TEMPLATE.md. -->
8 changes: 0 additions & 8 deletions .htmllintrc

This file was deleted.

3 changes: 0 additions & 3 deletions .lfsconfig

This file was deleted.

Loading

0 comments on commit 9679c9f

Please sign in to comment.