diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..ff1073d9e9 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..a9735917a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,39 @@ +### Problem description + + + +### Problem location + + + +[ ] I saw the problem on the following URL: + +[ ] I couldn't find the information I wanted. I expected to find it near the + following URL: + +[ ] Other: + +### Project version(s) affected + + + +### Suggestions for a fix + + + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..defba57988 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,47 @@ + + + + +### Describe the proposed changes + + + +### Project version + + + + + +### Related issue + + + +### Related issue or PR in another project + + + +### Please take a look + + + + +