kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
website/CONTRIBUTING.md

40 lines
2.6 KiB
Markdown
Raw Normal View History

creating contributing.md Adding a contributing.md file with contributing guidelines for docs on kubernetes.io (https://github.com/blog/1184-contributing-guidelines). This should not be merged until the PR for the docs style guide is merged. (https://github.com/kubernetes/kubernetes.github.io/pull/1619)
2016-11-08 22:49:02 +00:00
# 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
Use CoCC email for reporting CoC violations (#10621) * Use CoCC email for reporting CoC violations * Direct CoC concerns to the new committee
2018-10-15 23:33:34 +00:00
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 the
[Kubernetes Code of Conduct Committee](https://github.com/kubernetes/community/tree/master/committee-code-of-conduct) <conduct@kubernetes.io>.
creating contributing.md Adding a contributing.md file with contributing guidelines for docs on kubernetes.io (https://github.com/blog/1184-contributing-guidelines). This should not be merged until the PR for the docs style guide is merged. (https://github.com/kubernetes/kubernetes.github.io/pull/1619)
2016-11-08 22:49:02 +00:00
### 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
fix broken link: http://kubernetes.io/docs/home/contribute/page-templates/
2020-06-12 06:21:50 +00:00
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](https://kubernetes.io/docs/contribute/style/page-content-types/).
creating contributing.md Adding a contributing.md file with contributing guidelines for docs on kubernetes.io (https://github.com/blog/1184-contributing-guidelines). This should not be merged until the PR for the docs style guide is merged. (https://github.com/kubernetes/kubernetes.github.io/pull/1619)
2016-11-08 22:49:02 +00:00
## 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:
delete redundant space
2017-10-19 09:06:33 +00:00
1. Check the [kubernetes.io issues list](https://github.com/kubernetes/website/issues) as you might find out the issue is a duplicate.
2. Use the [included template for every new issue](https://github.com/kubernetes/website/issues/new). When you create a bug report, include as many details as possible and include suggested fixes to the issue.
creating contributing.md Adding a contributing.md file with contributing guidelines for docs on kubernetes.io (https://github.com/blog/1184-contributing-guidelines). This should not be merged until the PR for the docs style guide is merged. (https://github.com/kubernetes/kubernetes.github.io/pull/1619)
2016-11-08 22:49:02 +00:00
delete redundant space
2017-10-19 09:06:33 +00:00
Note that code issues should be filed against the main kubernetes repository, while documentation issues should go in the kubernetes.io repository.
creating contributing.md Adding a contributing.md file with contributing guidelines for docs on kubernetes.io (https://github.com/blog/1184-contributing-guidelines). This should not be merged until the PR for the docs style guide is merged. (https://github.com/kubernetes/kubernetes.github.io/pull/1619)
2016-11-08 22:49:02 +00:00
### Submitting Documentation Pull Requests
WIP: Cleanup /docs/contribute/ migration (#3278) * 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
2017-04-10 20:24:14 +00:00
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/).
chore: link to Start Contributing in CONTRIBUTING.md Signed-off-by: Kush Trivedi <kushthedude@gmail.com>
2020-08-28 09:41:52 +00:00
For more information, see [contributing to Kubernetes docs](https://kubernetes.io/docs/contribute/).