Skip to content

Commit fe25dda

Browse files
author
Misty Stanley-Jones
authored
Merge pull request docker#430 from mstanleyjones/vnext-opensource
Merge master into vnext-opensource
2 parents 6086d74 + 0847155 commit fe25dda

395 files changed

Lines changed: 5128 additions & 5660 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.NOT_EDITED_HERE.txt‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Files and directories here are not edited in the docker.github.io repo.
2+
# Instead, they are edited in the appropriate upstream repo and pulled
3+
# into this repo periodically. The intent is that if you submit a PR
4+
# with changes to these files or directories, a CI job will fail in the
5+
# PR, indicating that it should not be merged.
6+
7+
# If you need to edit these files or directories, submit a PR in one of the
8+
# following repos. The file will probably be located within the docs/ subdirectory.
9+
10+
# docker-trusted-registry: n/a, file an issue
11+
# engine: https://github.com/docker/docker
12+
# compose: https://github.com/docker/compose
13+
# notary: https://github.com/docker/notary
14+
# registry: https://github.com/docker/distribution
15+
# swarm: https://github.com/docker/swarm
16+
# ucp: n/a, file an issue
17+
18+
# Make sure directories have the trailing slash, keep the list alphabetical
19+
20+
apidocs/
21+
compose/reference/
22+
docker-trusted-registry/reference/
23+
engine/deprecated.md
24+
engine/extend/
25+
engine/reference/
26+
machine/reference/
27+
notary/reference/
28+
registry/configuration.md
29+
registry/spec/
30+
swarm/reference/
31+
ucp/reference/

‎.arcconfig‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎.babelrc‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎.bumpversion.cfg‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎.dockercfg.template‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.drone.yml‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎.editorconfig‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎.flowconfig‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎.github/CONTRIBUTING.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
## Contributing
2+
3+
We value your documentation contributions, and we want to make it as easy
4+
as possible to work in this repository. One of the first things to decide is
5+
which branch to base your work on. If you get confused, just ask and we will
6+
help. If a reviewer realizes you have based your work on the wrong branch, we'll
7+
let you know so that you can rebase it.
8+
9+
>**Note**: To contribute code to Docker projects, see the
10+
[Contribution guidelines](opensource/project/who-written-for).
11+
12+
### Quickstart
13+
14+
If you spot a problem while reading the documentation and want to try to fix it
15+
yourself, click the **Edit this page** link at the bottom of that page. The
16+
page will open in the Github editor, which means you don't need to know a lot
17+
about Git, or even about Markdown.
18+
19+
When you save, you will be prompted to create a fork if you don't already have
20+
one, and to create a branch in your fork and submit the pull request. We hope
21+
you give it a try!
22+
23+
### Overall doc improvements
24+
25+
Most commits will be made against the `master` branch. This include:
26+
27+
- Conceptual and task-based information not specific to new features
28+
- Restructuring / rewriting
29+
- Doc bug fixing
30+
- Typos and grammar errors
31+
32+
One quirk of this project is that the `master` branch is where the live docs are
33+
published from, so upcoming features can't be documented there. See
34+
[Specific new features for a project](#specific-new-features-for-a-project)
35+
for how to document upcoming features. These feature branches will be periodically
36+
merged with `master`, so don't worry about fixing typos and documentation bugs
37+
there.
38+
39+
>Do you enjoy creating graphics? Good graphics are key to great documentation,
40+
and we especially value contributions in this area.
41+
42+
### Specific new features for a project
43+
44+
Our docs cover many projects which release at different times. **If, and only if,
45+
your pull request relates to a currently unreleased feature of a project, base
46+
your work on that project's `vnext` branch.** These branches were created by
47+
cloning `master` and then importing a project's `master` branch's docs into it
48+
(at the time of the migration), in a way that preserved the commit history. When
49+
a project has a release, its `vnext` branch will be merged into `master` and your
50+
work will be visible on docs.docker.com.
51+
52+
The following `vnext` branches currently exist:
53+
54+
- **[vnext-engine](https://github.com/docker/docker.github.io/tree/vnext-engine):**
55+
docs for upcoming features in the [docker/docker](https://github.com/docker/docker/)
56+
project
57+
58+
- **[vnext-compose](https://github.com/docker/docker.github.io/tree/vnext-compose):**
59+
docs for upcoming features in the [docker/compose](https://github.com/docker/compose/)
60+
project
61+
62+
- **[vnext-distribution](https://github.com/docker/docker.github.io/tree/vnext-distribution):**
63+
docs for upcoming features in the [docker/distribution](https://github.com/docker/distribution/)
64+
project
65+
66+
- **[vnext-opensource](https://github.com/docker/docker.github.io/tree/vnext-opensource):**
67+
docs for upcoming features in the [docker/opensource](https://github.com/docker/opensource/)
68+
project
69+
70+
- **[vnext-swarm](https://github.com/docker/docker.github.io/tree/vnext-swarm):**
71+
docs for upcoming features in the [docker/swarm](https://github.com/docker/swarm/)
72+
project
73+
74+
- **[vnext-toolbox](https://github.com/docker/docker.github.io/tree/vnext-toolbox):**
75+
docs for upcoming features in the [docker/toolbox](https://github.com/docker/toolbox/)
76+
project
77+
78+
- **[vnext-kitematic](https://github.com/docker/docker.github.io/tree/vnext-kitematic):**
79+
docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
80+
project
81+
82+
## Style guide
83+
84+
If you have questions about how to write for Docker's documentation, please see
85+
the [style guide](https://docs.docker.com/opensource/doc-style/). The style guide provides
86+
guidance about grammar, syntax, formatting, styling, language, or tone. If
87+
something isn't clear in the guide, please submit an issue to let us know or
88+
submit a pull request to help us improve it.

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
### Problem description
2+
3+
<!-- Briefly describe the problem that you found. Only documentation issues should be filed here.
4+
For general questions, go to https://forums.docker.com/. -->
5+
6+
### Problem location
7+
8+
<!-- Help us find the problem quickly by choosing one of these. -->
9+
10+
- I saw a problem on the following URL: <URL>
11+
12+
- I couldn't find the information I wanted. I expected to find it near the following URL: <URL>
13+
14+
- Other: <DETAILS>
15+
16+
### Project version(s) affected
17+
18+
<!-- If this problem only affects specific versions of a project (like Docker
19+
Engine 1.13), tell us here. The fix may need to take that into account. -->
20+
21+
### Suggestions for a fix
22+
23+
<!--If you have specific ideas about how we can fix this, let us know. -->
24+
25+
26+
<!-- To improve this template, edit the .github/ISSUE_TEMPLATE.md file -->

0 commit comments

Comments
 (0)