centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-27 14:28:47 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add info about Netlify, convert .NOT_EDITED_HERE to YAML, other improvements (#485)

Browse Source 
* 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>
This commit is contained in:
Misty Stanley-Jones
2016-11-08 13:24:39 -08:00
committed by John Mulhausen
parent 86f2bdb13c
commit 9f15e72e5a
6 changed files with 110 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
.github/CONTRIBUTING.md vendored
View File

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

20
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

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