Sitelet https://github.com/johnpancoast/docker.github.io/commit/9f15e72e5a7cac0a63b5bb421806893fe1b7ca0e
Skip to content

Commit 9f15e72

Browse files
Misty Stanley-Jonesjohndmulhausen
Misty Stanley-Jones
authored and
johndmulhausen
committed
Add info about Netlify, convert .NOT_EDITED_HERE to YAML, other improvements (docker#485)
* Add info about Netlify, convert .NOT_EDITED_HERE to YAML, other misc improvements Signed-off-by: Misty Stanley-Jones <misty@docker.com> * Move YAML file, symlink it in the root Signed-off-by: Misty Stanley-Jones <misty@docker.com>
1 parent 86f2bdb commit 9f15e72

6 files changed

Lines changed: 110 additions & 49 deletions

File tree

‎.NOT_EDITED_HERE.txt‎

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

‎.NOT_EDITED_HERE.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_data/.NOT_EDITED_HERE.yaml

‎.github/CONTRIBUTING.md‎

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ let you know so that you can rebase it.
99
>**Note**: To contribute code to Docker projects, see the
1010
[Contribution guidelines](opensource/project/who-written-for).
1111

12+
### Files not edited here
13+
14+
Files and directories listed in the `path:` keys in
15+
[`.NOT_EDITED_HERE.yaml`](/NOT_EDITED_HERE.yaml) are maintained in other
16+
repositories and should not be edited in this one. Pull requests against these
17+
files will be rejected. Make your edits to the files in the repository and path
18+
in the `source:` key in the YAML file.
19+
1220
### Quickstart
1321

1422
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:
7987
docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
8088
project
8189

90+
## Collaborate on a pull request
91+
92+
Unless the PR author specifically disables it, you can push commits into another
93+
contributor's PR. You can do it from the command line by adding and fetching
94+
their remote, checking out their branch, and adding commits to it. Even easier,
95+
you can add commits from the Github web UI, by clicking the pencil icon for a
96+
given file in the **Files** view.
97+
98+
If a PR consists of multiple small addendum commits on top of a more significant
99+
one, the commit will usually be "squash-merged", so that only one commit is
100+
merged in. On occasion this is not appropriate and all commits will be kept
101+
separate when merging.
102+
103+
## Pull request guidelines
104+
105+
Help us review your PRs more quickly by following these guidelines.
106+
107+
- Try not to touch a large number of files in a single PR if possible.
108+
109+
- Don't change whitespace or line wrapping in parts of a file you are not
110+
editing for other reasons. Make sure your text editor is not configured to
111+
automatically reformat the whole file when saving.
112+
113+
- A Netlify test runs for each PR that is against one of our long-lived
114+
branches like `master` and the `vnext` branches, and deploys the result of
115+
your PR to a staging site. The URL will be available at the bottom of the PR
116+
in the **Conversation** view. Check the staging site for problems and fix them
117+
if necessary. Reviewers will check the staging site too.
118+
119+
If you can think of other ways we could streamline the review process, let us
120+
know.
121+
82122
## Style guide
83123

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.
124+
If you have questions about how to write for Docker's documentation, have a look
125+
at the [style guide](https://docs.docker.com/opensource/doc-style/). The style
126+
guide provides guidance about grammar, syntax, formatting, styling, language, or
127+
tone. If something isn't clear in the guide, please submit an issue to let us
128+
know or submit a pull request to help us improve it.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,29 @@
11
<!--Thanks for your contribution. See [CONTRIBUTING](CONTRIBUTING.md)
22
for this project's contribution guidelines. -->
33

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

77
### Describe the proposed changes
88

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

12-
### Project version
11+
### Unreleased project version
1312

14-
<!-- If this change only applies to a future version of a project (like
15-
Docker Engine 1.13), note that here and base your work on the `vnext-`
16-
branch for your project. -->
13+
<!-- If this change only applies to an unreleased version of a project, note
14+
that here and base your work on the `vnext-` branch for your project. -->
1715

1816
### Related issue
1917

20-
<!-- If this relates to an issue or PR in this repo, refer to it like
21-
#1234, or 'Fixes #1234' or 'Closes #1234'. -->
18+
<!-- Refer to related PRs or issues: #1234, or 'Fixes #1234' or 'Closes #1234'. -->
2219

2320
### Related issue or PR in another project
2421

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

2724
### Please take a look
2825

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

3228

3329
<!-- To improve this template, edit .github/PULL_REQUEST_TEMPLATE.md. -->

‎README.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ let you know so that you can rebase it.
3434
>**Note**: To contribute code to Docker projects, see the
3535
[Contribution guidelines](opensource/project/who-written-for).
3636

37+
### Files not edited here
38+
39+
Files and directories listed in the `path:` keys in
40+
[`.NOT_EDITED_HERE.yaml`](.NOT_EDITED_HERE.yaml) are maintained in other
41+
repositories and should not be edited in this one. Pull requests against these
42+
files will be rejected. Make your edits to the files in the repository and path
43+
in the `source:` key in the YAML file.
44+
3745
### Overall doc improvements
3846

3947
Most commits will be made against the `master` branch. This include:
@@ -93,8 +101,17 @@ The following `vnext` branches currently exist:
93101
docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
94102
project
95103

104+
## Per-PR staging on Github
105+
106+
For every PR against `master` and all the long-lived branches, a staged version
107+
of the site is built using Netlify. If the site builds, you will see
108+
**deploy/netlify — Deploy preview ready**. Otherwise, you will see an error.
109+
Click **Details** to review the staged site or the errors that prevented it from
110+
building. Review the staged site and amend your commit if necessary. Reviewers
111+
will also check the staged site before merging the PR, to protect the integrity
112+
of [docs.docker.com](http://docs.docker.com/).
96113

97-
## Staging
114+
## Staging locally
98115

99116
You have three options:
100117

‎_data/.NOT_EDITED_HERE.yaml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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, or they are automatically generated. The intent
4+
# is that if you submit a PR with changes to these files or directories, a CI
5+
# job will fail in the PR, indicating that it should not be merged. THIS IS NOT
6+
# YET IMPLEMENTED!! The PR reviewer should make sure no files here are in the PR.
7+
8+
# If you need to edit these files or directories, submit a PR in the repo and
9+
# directory listed in "source" below.
10+
11+
# Make sure directories have the trailing slash, keep the list alphabetical
12+
13+
- path: apidocs/
14+
description: "Auto-generated API docs for Docker Cloud, DTR, UCP. File an issue."
15+
16+
- path: engine/deprecated.md
17+
description: Docker Engine deprecation reference
18+
source: https://github.com/docker/docker/docs/deprecated.md
19+
20+
- path: engine/extend/
21+
description: References for Docker Engine plugin system
22+
source: https://github.com/docker/docker/docs/extend/
23+
24+
- path: engine/reference/
25+
description: Docker Engine CLI and API references
26+
source: https://github.com/docker/docker/docs/reference/
27+
28+
- path: notary/reference/
29+
description: Reference docs for Docker Notary
30+
source: https://github.com/docker/notary/docs/reference/
31+
32+
- path: registry/configuration.md
33+
description: Reference docs for configuring Docker Registry
34+
source: https://github.com/docker/distribution/docs/configuration.md
35+
36+
- path: registry/spec/
37+
description: Docker Registry API references
38+
source: https://github.com/docker/distribution/docs/spec/

0 commit comments

Comments
 (0)