mirror of https://github.com/k3s-io/k3s
Update .md files with url and email corrections
* BUILDING.md * CODE_OF_CONDUCT.md * CONTRIBUTING.md * MAINTAINERS * README.md Signed-off-by: David Nuzik <david.nuzik@rancher.com>pull/3002/head
parent
f970e49b7d
commit
4816d54caa
|
@ -1,4 +1,4 @@
|
||||||
See the [release](https://github.com/rancher/k3s/releases/latest) page for pre-built releases.
|
See the [release](https://github.com/k3s-io/k3s/releases/latest) page for pre-built releases.
|
||||||
|
|
||||||
The clone will be much faster on this repo if you do
|
The clone will be much faster on this repo if you do
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -32,7 +32,7 @@ Conduct may be permanently removed from the project team.
|
||||||
This code of conduct applies both within project spaces and in public spaces
|
This code of conduct applies both within project spaces and in public spaces
|
||||||
when an individual is representing the project or its community.
|
when an individual is representing the project or its community.
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a Rancher administrator on [Slack](https://slack.rancher.io), or <conduct@rancher.com>.
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a Rancher administrator on [Slack](https://slack.rancher.io), or <conduct@suse.com>.
|
||||||
|
|
||||||
This Code of Conduct is adapted from the Contributor Covenant
|
This Code of Conduct is adapted from the Contributor Covenant
|
||||||
(http://contributor-covenant.org), version 1.2.0, available at
|
(http://contributor-covenant.org), version 1.2.0, available at
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Thanks for taking the time to contribute to k3s!
|
Thanks for taking the time to contribute to k3s!
|
||||||
|
|
||||||
Contributing is not limited to writing code and submitting a PR. Feel free to submit an [issue](https://github.com/rancher/k3s/issues/new/choose) or comment on an existing one to report a bug, provide feedback, or suggest a new feature. You can also join the discussion on [slack](https://slack.rancher.io/).
|
Contributing is not limited to writing code and submitting a PR. Feel free to submit an [issue](https://github.com/k3s-io/k3s/issues/new/choose) or comment on an existing one to report a bug, provide feedback, or suggest a new feature. You can also join the discussion on [slack](https://slack.rancher.io/).
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
20
MAINTAINERS
20
MAINTAINERS
|
@ -1,13 +1,13 @@
|
||||||
# The following is the list of current K3s maintainers
|
# The following is the list of current K3s maintainers
|
||||||
# Github ID, Name, Email Address
|
# Github ID, Name, Email Address
|
||||||
|
|
||||||
brandond, Brad Davidson, brad.davidson@rancher.com
|
brandond, Brad Davidson, brad.davidson@suse.com
|
||||||
briandowns, Brian Downs, brian.downs@rancher.com
|
briandowns, Brian Downs, brian.downs@suse.com
|
||||||
cjellick, Craig Jellick, craig@rancher.com
|
cjellick, Craig Jellick, craig.jellick@suse.com
|
||||||
dweomer, Jacob Blain Christen, jacob@rancher.com
|
dweomer, Jacob Blain Christen, jacob.blainchristen@suse.com
|
||||||
erikwilson, Erik Wilson, erik@rancher.com
|
erikwilson, Erik Wilson, erik.wilson@suse.com
|
||||||
galal-hussein, Hussein Galal, hussein@rancher.com
|
galal-hussein, Hussein Galal, hussein.galalabdelazizahmed@suse.com
|
||||||
ibuildthecloud, Darren Shepherd, darren@rancher.com
|
ibuildthecloud, Darren Shepherd, darren.shepherd@suse.com
|
||||||
MonzElmasry, Menna Elmasry, menna.elmasry@rancher.com
|
MonzElmasry, Menna Elmasry, menna.elmasry@suse.com
|
||||||
Oats87, Chris Kim, chris.kim@rancher.com
|
Oats87, Chris Kim, chris.kim@suse.com
|
||||||
davidnuzik, David Nuzik, david.nuzik@rancher.com
|
davidnuzik, David Nuzik, david.nuzik@suse.com
|
||||||
|
|
10
README.md
10
README.md
|
@ -33,7 +33,7 @@ K3s bundles the following technologies together into a single cohesive distribut
|
||||||
* [CoreDNS](https://coredns.io/)
|
* [CoreDNS](https://coredns.io/)
|
||||||
* [Metrics Server](https://github.com/kubernetes-sigs/metrics-server)
|
* [Metrics Server](https://github.com/kubernetes-sigs/metrics-server)
|
||||||
* [Traefik](https://containo.us/traefik/) for ingress
|
* [Traefik](https://containo.us/traefik/) for ingress
|
||||||
* [Klipper-lb](https://github.com/rancher/klipper-lb) as an embedded service loadbalancer provider
|
* [Klipper-lb](https://github.com/k3s-io/klipper-lb) as an embedded service loadbalancer provider
|
||||||
* [Kube-router](https://www.kube-router.io/) for network policy
|
* [Kube-router](https://www.kube-router.io/) for network policy
|
||||||
* [Helm-controller](https://github.com/k3s-io/helm-controller) to allow for CRD-driven deployment of helm manifests
|
* [Helm-controller](https://github.com/k3s-io/helm-controller) to allow for CRD-driven deployment of helm manifests
|
||||||
* [Kine](https://github.com/k3s-io/kine) as a datastore shim that allows etcd to be replaced with other databases
|
* [Kine](https://github.com/k3s-io/kine) as a datastore shim that allows etcd to be replaced with other databases
|
||||||
|
@ -92,7 +92,7 @@ Release cadence
|
||||||
---
|
---
|
||||||
K3s maintains pace with upstream Kubernetes releases. Our goal is to release patch releases on the same day as upstream and minor releases within a few days.
|
K3s maintains pace with upstream Kubernetes releases. Our goal is to release patch releases on the same day as upstream and minor releases within a few days.
|
||||||
|
|
||||||
Our release versioning reflects the version of upstream Kubernetes that is being released. For example, the K3s release [v1.18.6+k3s1](https://github.com/rancher/k3s/releases/tag/v1.18.6%2Bk3s1) maps to the `v1.18.6` Kubernetes release. We add a postfix in the form of `+k3s<number>` to allow us to make additional releases using the same version of upstream Kubernetes, while remaining [semver](https://semver.org/) compliant. For example, if we discovered a high severity bug in `v1.18.6+k3s1` and needed to release an immediate fix for it, we would release `v1.18.6+k3s2`.
|
Our release versioning reflects the version of upstream Kubernetes that is being released. For example, the K3s release [v1.18.6+k3s1](https://github.com/k3s-io/k3s/releases/tag/v1.18.6%2Bk3s1) maps to the `v1.18.6` Kubernetes release. We add a postfix in the form of `+k3s<number>` to allow us to make additional releases using the same version of upstream Kubernetes, while remaining [semver](https://semver.org/) compliant. For example, if we discovered a high severity bug in `v1.18.6+k3s1` and needed to release an immediate fix for it, we would release `v1.18.6+k3s2`.
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
@ -128,7 +128,7 @@ curl -sfL https://get.k3s.io | K3S_URL=https://myserver:6443 K3S_TOKEN=XXX sh -
|
||||||
Manual Download
|
Manual Download
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
1. Download `k3s` from latest [release](https://github.com/rancher/k3s/releases/latest), x86_64, armhf, and arm64 are supported.
|
1. Download `k3s` from latest [release](https://github.com/k3s-io/k3s/releases/latest), x86_64, armhf, and arm64 are supported.
|
||||||
2. Run server.
|
2. Run server.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -144,9 +144,9 @@ sudo k3s agent --server https://myserver:6443 --token ${NODE_TOKEN}
|
||||||
Contributing
|
Contributing
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Please check out our [contributing guide](CONTRIBUTING.md) if you're interesting in contributing to k3s.
|
Please check out our [contributing guide](CONTRIBUTING.md) if you're interested in contributing to K3s.
|
||||||
|
|
||||||
Security
|
Security
|
||||||
--------
|
--------
|
||||||
|
|
||||||
Security issues in k3s can be reported by sending an email to [security@rancher.com](mailto:security@rancher.com). Please do not file issues about security issues.
|
Security issues in K3s can be reported by sending an email to [security@k3s.io](mailto:security@k3s.io). Please do not file issues about security issues.
|
||||||
|
|
Loading…
Reference in New Issue