Skip to content

Commit

Permalink
Provide initial support policy for KEDA (kedacore#1343)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkerkhove authored Nov 19, 2020
1 parent bc4238b commit 0b64a68
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ We are a Cloud Native Computing Foundation (CNCF) sandbox project.
**Table of contents**

- [Getting started](#getting-started)
- [Deploying KEDA](#deploying-keda)
- [Deploying KEDA](#deploying-keda)
- [Documentation](#documentation)
- [Guidelines](#guidelines)
- [Governance & Policies](#governance--policies)
- [Support](#support)
- [Branding](#branding)
- [FAQ](#faq)
- [Community](#community)
- [Become a listed KEDA user!](#become-a-listed-keda-user)
- [Become a listed KEDA user!](#become-a-listed-keda-user)
- [Releases](#releases)
- [Contributing](#contributing)
- [Building & deploying locally](#building--deploying-locally)
- [Building & deploying locally](#building--deploying-locally)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -43,23 +43,23 @@ We are a Cloud Native Computing Foundation (CNCF) sandbox project.

You can find several samples for various event sources [here](https://github.com/kedacore/samples).

## Deploying KEDA
### Deploying KEDA

There are many ways to [deploy KEDA including Helm, Operator Hub and YAML files](https://keda.sh/docs/latest/deploy/).

## Documentation

Interested to learn more? Head over to [keda.sh](https://keda.sh).

## Guidelines
## Governance & Policies

### Branding
## Support

We provide guidelines around branding of KEDA and related logos, learn more in our [guidelines](./BRANDING.md).
You can learn more about our docs, getting support and Kubernetes support policy in [our support policy](./SUPPORT.md).

## FAQ
### Branding

You can find a [FAQ here](https://keda.sh/docs/latest/faq/) with some common questions.
We provide guidelines around branding of KEDA and related logos, learn more in our [guidelines](./BRANDING.md).

## Community

Expand All @@ -74,7 +74,7 @@ If interested in contributing or participating in the direction of KEDA, you can
Just want to learn or chat about KEDA? Feel free to join the conversation in
**[#KEDA](https://kubernetes.slack.com/messages/CKZJ36A5D)** on the **[Kubernetes Slack](https://slack.k8s.io/)**!

## Become a listed KEDA user!
### Become a listed KEDA user!

We are always happy to [list users](https://keda.sh/community/#users) who run KEDA in production, learn more about it [here](https://github.com/kedacore/keda-docs#become-a-listed-keda-user).

Expand All @@ -86,5 +86,5 @@ You can find the latest releases [here](https://github.com/kedacore/keda/release

You can find contributing guide [here](./CONTRIBUTING.md).

## Building & deploying locally
### Building & deploying locally
Learn how to build & deploy KEDA locally [here](./BUILD.md).
31 changes: 31 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Support for deploying and using KEDA

Thank you for using KEDA!

KEDA is an open-source project under CNCF Foundation and provides best-effort support and use GitHub for tracking bugs and feature requests.

Want to contribute a feature or fix? We are more than happy to review requests and contributions, but recommend going through our [contribution guide](./CONTRIBUTING.md).

## Documentation

* [User Documentation](https://keda.sh/)
* [Troubleshooting Guide](https://keda.sh/docs/2.0/troubleshooting/)
* [FAQ](https://keda.sh/docs/latest/faq/)

## Community

We have a nice community that is always happy to help each other:

* [GitHub Discussions](https://github.com/kedacore/keda/discussions/new)
* [Slack](https://kubernetes.slack.com) ([registration](http://slack.k8s.io)):
The `#keda` channel is usually the place where people offer support.

## Kubernetes Support

The supported window of Kubernetes versions with KEDA is known as "N-2" which means that KEDA will provide support for running on N-2 at least.

However, maintainers can decide to extend this by supporting more minor versions based on the required CRDs being used; but there is no guarantee.

> Example - At time of writing, Kubernetes 1.19 is the latest minor version so KEDA can only use new features that were introduced in 1.17
You can learn more about the currently supported Kubernetes version in our [FAQ](https://keda.sh/docs/latest/faq/).

0 comments on commit 0b64a68

Please sign in to comment.