Skip to content

Commit

Permalink
Docs: add community page (#149)
Browse files Browse the repository at this point in the history
* add community page

* reformat lines

* change GH refs
  • Loading branch information
evilnick authored Feb 26, 2024
1 parent 96bd6fa commit db69113
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
74 changes: 74 additions & 0 deletions docs/src/reference/community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Welcome to the Canonical Kubernetes community!

This rapidly growing community is a diverse bunch of people - developers,
Kubernetes admins, inventors, researchers, students… and we all share the joy
of a reliable, flexible, secure, timely version of upstream Kubernetes. The
team recognise the important role each and every user plays in the success of
the project as a whole and how valuable your contributions are.

## Do you have questions?

Do you have questions about Canonical Kubernetes? Perhaps you want some ideas
on how to best achieve a certain goal or maybe some aspect of your Kubernetes
doesn't behave the way you expect. Perhaps you'd just like some advice from
more experienced users. There are a number of ways to get in touch:

- Using the [Kubernetes slack][slack]: find us in the #canonical-kubernetes channel
- In the public [Matrix room][matrix]
- On the [Ubuntu Discourse][discourse]

For more formal support, please see the support options available to you on the
[Ubuntu website][support].

**Our commitment to you** - we may not always be able to answer your questions,
but we promise to respond within three working days.

## Found a bug?

You can always track what is going on with development by tracking the
developments on GitHub. This is also the best place to file a bug if you find
one, or of course you are also welcome to contribute to the code.

**Our commitment to you** - we monitor the issues on GitHub regularly and we
aim to triage all bug reports within three working days.


## Contributing to the code?

Canonical Kubernetes is proudly open source, published under the GPLv3 license.
We welcome and encourage contributions to the code. Please see the [Developer
guide] for more information on contributing.

**Our commitment to you** - we closely follow activity on the source
repository. We aim to respond to any PRs within three working days.

## Contributing to docs?

Our documentation is extremely important to us and is actively maintained by
the entire team. That doesn't mean that it can't be improved though. Every page
in the documentation has an "Edit this page" link in the top right which takes
you to GitHub to make small changes. For larger contributions, please see the
[Contributing guide].

**Our commitment to you**: Comments are usually read daily and we are really
grateful for docs improvements.

## Code of conduct

Building a fair, open and inclusive community is important to us. We think
adopting a code of conduct is a sensible way to make sure that everybody
participating understands what the expectations and obligations are. The team
adopts the [Ubuntu Code of Conduct
2.0](https://ubuntu.com/community/ethos/code-of-conduct), and we use these as
the guidelines for participation.


<!-- LINKS -->

[slack]: http://slack.kubernetes.io/
[matrix]: https://matrix.to/#/#k8s:ubuntu.com
[Discourse]: https://discourse.ubuntu.com/c/kubernetes/180
[bugs]: https://github.com/canonical/k8s-snap/issues
[Contributing guide]: *TODO*
[Developer guide]: *TODO*
[support]: https://ubuntu.com/support
1 change: 1 addition & 0 deletions docs/src/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Overview <self>
:glob:
:titlesonly:
/reference/releases
/reference/community
```

Alternatively, the [Tutorials section] contains step-by-step tutorials to help
Expand Down

0 comments on commit db69113

Please sign in to comment.