mirror of https://github.com/docker/docs.git
Merge pull request #172 from mstanleyjones/add_github_templates
Add github templates
This commit is contained in:
Misty Stanley-Jones
GitHub
commit
943c8dfc0b
|
|
@ -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.
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
### Problem description
|
||||
|
||||
<!-- Provide a brief description of the problem with
|
||||
the documentation.
|
||||
|
||||
If this is an issue with Docker itself, rather than
|
||||
the Docker documentation, this may not be the right
|
||||
place to file the issue. Consider filing it in the
|
||||
specific project's repository or asking a question
|
||||
on forums.docker.com.
|
||||
|
||||
You can delete these comments as you are filling out
|
||||
the template. -->
|
||||
|
||||
### Problem location
|
||||
|
||||
<!-- Help us find the problem quickly by choosing one of these: -->
|
||||
|
||||
[ ] 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
|
||||
|
||||
<!-- If this problem only affects specific versions of a
|
||||
project (like Docker Engine 1.13), mention it here. The fix
|
||||
may need to take that into account. -->
|
||||
|
||||
### Suggestions for a fix
|
||||
|
||||
<!--If you have specific ideas for how the problem
|
||||
can be addressed, let us know.-->
|
||||
|
||||
|
||||
|
||||
<!-- To improve this template, edit the .github/ISSUE_TEMPLATE.md file -->
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
<!--Thanks for your contribution. Please use the following
|
||||
guidelines to help us review it. You can remove these comments
|
||||
as you fill out this template. -->
|
||||
|
||||
<!-- **Squash your commits**: Please use an
|
||||
[interactive rebase](https://help.github.com/articles/about-git-rebase/)
|
||||
to squash (combine) multiple commits into a single commit, to keep the
|
||||
commit history clean. The exception is when commits from multiple
|
||||
contributors exist in the same pull request. In that case, one commit
|
||||
per contributor is preferred, to keep the history clean but also give
|
||||
credit for the work to all contributors. -->
|
||||
|
||||
### Describe the proposed changes
|
||||
|
||||
<!-- Tell us what you did and why. You can leave this off if
|
||||
the PR title is descriptive. -->
|
||||
|
||||
### Project version
|
||||
|
||||
<!-- If this change only applies to a certain version of a project
|
||||
(like Docker Engine 1.13), note that here. Also, consider adding
|
||||
that info to the docs in your change, such as by adding
|
||||
"In Docker 1.13 and higher..." or similar. -->
|
||||
|
||||
<!-- Also, DO NOT base your work on master if your change is only
|
||||
relevant to an unreleased version of a project. Instead, base
|
||||
your work on the `vnext-<PROJECT>` branch, which will be merged
|
||||
into master when that project has a new release.-->
|
||||
|
||||
### Related issue
|
||||
|
||||
<!-- If this relates to an issue or PR in this repo, refer to it
|
||||
like #1234 -->
|
||||
|
||||
### Related issue or PR in another project
|
||||
|
||||
<!-- Provide one or more links to issues or pull requests in
|
||||
other repositories. For instance, a link to the PR that
|
||||
introduces a code change that this PR is documenting. -->
|
||||
|
||||
### Please take a look
|
||||
|
||||
<!-- Use this section to at-mention specific individuals who should take a
|
||||
look at this PR. For instance, @exampleuser123-->
|
||||
|
||||
|
||||
<!-- To improve this template, edit .github/PULL_REQUEST_TEMPLATE.md. -->
|
||||
Loading…
Reference in New Issue