github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Move docs contributing to contributing guide 

Signed-off-by: Craig Jellick <craig@rancher.com>
pull/1952/head
Craig Jellick 2020-06-24 17:46:56 -07:00
parent d0c95a307c
commit cef1f1d641
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -6,6 +6,10 @@ Contributing is not limited to writing code and submitting a PR. Feel free to su
Of course, contributing code is more than welcome! To keep things simple, if you're fixing a small issue, you can simply submit a PR and we will pick it up. However, if you're planning to submit a bigger PR to implement a new feature or fix a relatively complex bug, please open an issue that explains the change and the motivation for it. If you're addressing a bug, please explain how to reproduce it.
If you're interesting in contributing documentation, please note the following:
- Doc issues are raised in this repository, and they are tracked under the `kind/documentation` label.
- Pull requests are submitted to the K3s documentation source in the [Rancher docs repository.](https://github.com/rancher/docs/) The K3s docs content is in the `content/k3s/` directory.
## Developer Certificate Of Origin ##
To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.

9
README.md
View File

@ -44,11 +44,6 @@ Documentation
Please see [the official docs site](https://rancher.com/docs/k3s/latest/en/) for complete documentation on k3s.
## Contributing to the Docs
- **Issues:** Doc issues are raised in this repository, and they are tracked under the `kind/documentation` label.
- **Pull Requests:** Pull requests are submitted to the K3s documentation source code in the [Rancher docs repository.](https://github.com/rancher/docs/) The K3s docs content is in the `content/k3s/` directory.
Quick-Start - Install Script
--------------
@ -90,3 +85,7 @@ sudo k3s kubectl get nodes
sudo k3s agent --server https://myserver:6443 --token ${NODE_TOKEN}
```
Contributing
------------
Please check out our [contributing guide](CONTRIBUTING.md) if you're interesting in contributing to k3s.