Andrew Chen
005fce03fe
* WIP: Cleanup /docs/contribute/ migration * #3278 Changing /docs/contribute to /docs/home/contribute (#3285) * WIP: #3278 Adding redirects /docs/contribute/ /docs/home/contribute/ * WIP: #3278 modifying /docs/contribute/ paths within files to /docs/home/contribute/ * Revert "WIP: #3278 Adding redirects /docs/contribute/ /docs/home/contribute/" This reverts commit a82efdee505d7a409cb3c86240cc0ee976a2e566. * WIP: #3278 Adding redirects /docs/contribute/ /docs/home/contribute/ * WIP: #3278 Correcting syntax mistake in redirect.js * WIP: #3278 Correcting another syntax mistake in redirect.js * WIP: #3278 Removing deprecated files so redirects work * Removing the # * WIP: #3278 Updating pattern in redirect.js * WIP: #3278 Removed the wrong # previously redirect.js
37 lines
2.5 KiB
Markdown
37 lines
2.5 KiB
Markdown
# Contributing to Kubernetes Documentation
|
||
|
||
**First off, thanks for taking the time to contribute!**
|
||
|
||
The following is a set of guidelines for contributing to Kubernetes documentation, hosted at [Kubernetes.io](http://kubernetes.io/).
|
||
These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
||
|
||
## Before you get started
|
||
|
||
### Code of Conduct
|
||
|
||
Kubernetes follows the [Cloud Native Computing Foundation (CNCF) Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to Sarah Novotny [sarahnovotny@google.com](mailto:sarahnovotny@google.com) and/or Dan Kohn [dan@linuxfoundation.org](mailto:dan@linuxfoundation.org).
|
||
|
||
### Documentation and Site Decisions
|
||
|
||
The [Kubernetes SIG Docs Discussion Group](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) is the discussion group for doc releases, suggested site improvements, and improving the doc contribution experience. If you are planning to be a regular contributor, join this group to stay informed and involved.
|
||
|
||
### Style Guides and Templates
|
||
|
||
Before submitting a pull request to create new content, please review the [Kubernetes.io style guide](http://kubernetes.io/docs/home/contribute/style-guide/) and follow the [instructions for using page templates](http://kubernetes.io/docs/home/contribute/page-templates/).
|
||
|
||
|
||
## Contributing to Documentation
|
||
|
||
### Reporting Documentation Issues
|
||
|
||
Kubernetes.io uses github issues to track documentation issues and requests. If you see a documentation issue, submit an issue using the following steps:
|
||
|
||
1. Check the [kubernetes.io issues list](https://github.com/kubernetes/kubernetes.github.io/issues) as you might find out the issue is a duplicate.
|
||
2. Use the [included template for every new issue](https://github.com/kubernetes/kubernetes.github.io/issues/new). When you create a bug report, include as many details as possible and include suggested fixes to the issue.
|
||
|
||
Note that code issues should be filed against the main kubernetes repository, while documentation issues should go in the kubernetes.io repository.
|
||
|
||
### Submitting Documentation Pull Requests
|
||
|
||
If you're fixing an issue in the existing documentation, you should submit a PR against the master branch. Follow [these instructions to create a documentation pull request against the kubernetes.io repository](http://kubernetes.io/docs/home/contribute/create-pull-request/).
|