From cef1f1d6414f872f25c9b282a8704434429bb5f6 Mon Sep 17 00:00:00 2001 From: Craig Jellick Date: Wed, 24 Jun 2020 17:46:56 -0700 Subject: [PATCH] Move docs contributing to contributing guide Signed-off-by: Craig Jellick --- CONTRIBUTING.md | 4 ++++ README.md | 9 ++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56ab80f918..abae43f28e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index f1a3db2d63..e35c1b517c 100644 --- a/README.md +++ b/README.md @@ -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.