Skip to content

Commit

Permalink
Merge pull request #922 from k8up-io/community-update
Browse files Browse the repository at this point in the history
K8up community update
  • Loading branch information
tobru authored Feb 1, 2024
2 parents 8978cb3 + ed2371a commit faf3001
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 136 deletions.
6 changes: 6 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Community Code of Conduct

K8up observes the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).

The code of conduct is overseen by the K8up project maintainers.
Possible code of conduct violations should be emailed to the project maintainers [email protected].
11 changes: 5 additions & 6 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# K8up Project Governance

Please note: K8up is a young Open Source project, evolved from the project sponsor [VSHN](https://www.vshn.ch/).
As such we're in the process of setting up a proper project governance.
As such, we're in the process of setting up a proper project governance.
If you have any wish, let use know via a [GitHub Discussion](https://github.com/k8up-io/k8up/discussions).

## Principles
Expand All @@ -11,7 +11,7 @@ The K8up community adheres to the following principles:
- Open: K8up is open source.
- Welcoming and respectful: See [Code of Conduct](#code-of-conduct).
- Transparent and accessible: Changes to the K8up organization, K8up code repositories,
and CNCF related activities (e.g. level, involvement, etc) are done in public.
and CNCF related activities (e.g. level, involvement, etc.) are done in public.
- Merit: Ideas and contributions are accepted according to their technical merit and alignment with
project objectives, scope, and design principles.

Expand All @@ -24,7 +24,7 @@ The K8up roadmap is on GitHub, see [Projects -> Roadmap](https://github.com/k8up
Every contribution is welcome.
Please see our [Contribution Guide](https://k8up.io/k8up/about/contribution_guide.html) how to best contribute.

## Github Project Administration
## GitHub Project Administration

The __k8up-io__ GitHub project maintainers team reflects the list of Maintainers.

Expand All @@ -35,12 +35,12 @@ As such, K8up might be involved in CNCF (or other CNCF projects) related marketi

## Code of Conduct

Please read our code of conduct here: https://k8up.io/k8up/about/code_of_conduct.html
Please read our code of conduct here: [CODE_OF_CONDUCT.md](https://github.com/k8up-io/k8up/blob/master/CODE_OF_CONDUCT.md).

The code of conduct is overseen by the K8up project maintainers.
Possible code of conduct violations should be emailed to the project maintainers [email protected].

If the possible violation is against one of the project maintainers that member will be recused from voting on the issue.
If the possible violation is against one of the project maintainers, that member will be recused from voting on the issue.
Such issues must be escalated to the appropriate CNCF contact, and CNCF may choose to intervene.

## DCO and Licenses
Expand All @@ -49,4 +49,3 @@ The following licenses and contributor agreements will be used for K8up projects

* [Apache 2.0](https://opensource.org/licenses/Apache-2.0) for code
* [Developer Certificate of Origin](https://developercertificate.org/) for new contributions

8 changes: 7 additions & 1 deletion OWNERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@ This will be built up when time comes.

## Maintainers

We document the list of maintainers in the [GitHub team "Maintainer"](https://github.com/orgs/k8up-io/teams/maintainer/members).
* Tobias Brunner <[email protected]> ([tobru](https://github.com/tobru))
* Simon Beck <[email protected]> ([Kidswiss](https://github.com/Kidswiss))
* Nicolas Bigler <[email protected]> ([TheBigLee](https://github.com/TheBigLee))
* Łukasz Widera <[email protected]> ([wejdross](https://github.com/wejdross))
* Gabriel Saratura <[email protected]> ([zugao](https://github.com/zugao))

We also document the list of maintainers in the [GitHub team "Maintainer"](https://github.com/orgs/k8up-io/teams/maintainer/members).

## Reviewers

Expand Down
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ K8up is a Kubernetes backup operator based on [Restic](https://restic.readthedoc
Just create a `schedule` and a `credentials` object in the namespace you’d like to backup.
It’s that easy. K8up takes care of the rest. It also provides a Prometheus endpoint for monitoring.

K8up is production ready. It is used in production deployments since 2019.

## Documentation

The documentation is written in AsciiDoc and published with Antora to [k8up.io](https://k8up.io/).
Expand Down Expand Up @@ -141,7 +143,19 @@ make clean
There are a number of example configurations in [`config/samples`](config/samples).
Apply them using `kubectl apply -f config/samples/somesample.yaml`

### Code of Conduct
# Community

Read more about our community [in the documentation](https://k8up.io/k8up/about/community.html).

## Chat with us

The K8up project is present in the [CNCF Slack Workspace](https://slack.cncf.io/) in the [#k8up channel](https://app.slack.com/client/T08PSQ7BQ/C06GP0D5FEF).

## Monthly community meeting

We host a monthly community meeting. For more information, head over to [the community documentation](https://k8up.io/k8up/about/community.html).

## Code of Conduct

Our code of conduct can be read at [k8up.io](https://k8up.io/k8up/about/code_of_conduct.html).

Expand Down
127 changes: 2 additions & 125 deletions docs/modules/ROOT/pages/about/code_of_conduct.adoc
Original file line number Diff line number Diff line change
@@ -1,127 +1,4 @@

= Contributor Covenant Code of Conduct
= Code of Conduct

== Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

== Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what's best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

== Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

== Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

== Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

== Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

=== 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

=== 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces and external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

=== 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

=== 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

== Attribution

This Code of Conduct is adapted from the https://www.contributor-covenant.org[Contributor Covenant],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by https://github.com/mozilla/diversity[Mozilla's code of conduct
enforcement ladder].

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
Please consult the https://github.com/k8up-io/k8up/blob/master/CODE_OF_CONDUCT.md[CODE_OF_CONDUCT.md] file.
29 changes: 27 additions & 2 deletions docs/modules/ROOT/pages/about/community.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,35 @@
Connect with the K8up community:

https://github.com/k8up-io/k8up/discussions[Discussions]:: The project has GitHub discussions enabled where we discuss everything around K8up. Feel free to hop in there.
https://community.appuio.ch/[Chat]:: We use the _APPUiO Community Chat_ (registration open) and are reachable in the https://community.appuio.ch/channel/k8up[#k8up] channel.
https://app.slack.com/client/T08PSQ7BQ/C06GP0D5FEF[Chat]:: We use the https://slack.cncf.io/[CNCF Slack Workspace] and are reachable in the #k8up channel.
https://github.com/k8up-io/k8up[GitHub]:: The source code and issue tracking is available on _GitHub_ under https://github.com/k8up-io/k8up[k8up-io/k8up].
<<Monthly community meeting>>:: Join us in our monthly recurring community meeting.

== Monthly community meeting

The K8up community hosts a monthly community meeting in Zoom:

Time and Date::
Every first Monday of the month at 5:00 PM Europe/Zurich timezone.
You can use https://www.timeanddate.com/worldclock/converter.html?p1=268[timeanddate.com^] to convert into your timezone.

Zoom link::
https://vshn.zoom.us/j/82326347868?pwd=0ImBHdwZH98raNP78fFlVI9zci7w6w.1[Zoom^]

The agenda::
We collect inputs for the agenda beforehand in the community Slack channel.
+
The general agenda is:

* Ask the maintainer
* Discuss roadmap

Currently, we don't do any recordings of the meeting, until the community wishes to do so.

== Maintainer

Current maintainers are documented in the https://github.com/k8up-io/k8up/blob/master/OWNERS.md[OWNERS.md] file.

[discrete]
== Project sponsor

The project is sponsored by https://vshn.ch/[VSHN AG].
8 changes: 7 additions & 1 deletion docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,15 @@ K8up (pronounced `/keɪtæpp/` or simply "ketchup") is a Kubernetes Operator dis
* Check the backup repository for its integrity.
* Prune old backups from a repository.
* Restore backups with the help of the k8up CLI tool.

K8up is:

* Stable and production ready since 2019.
* Based on top of https://restic.readthedocs.io/en/latest/[Restic], it can store backups in any S3-compatible storage, such as Amazon S3 or https://github.com/minio/minio#readme[Minio].
* Written in https://golang.org/[Go].
* A https://www.cncf.io/sandbox-projects/[CNCF Sandbox] Open Source project, https://github.com/k8up-io/k8up[hosted at GitHub].

K8up is written in https://golang.org/[Go] and is an Open Source project https://github.com/k8up-io/k8up[hosted at GitHub].
https://landscape.cncf.io/?item=runtime\--cloud-native-storage\--k8up[image:https://img.shields.io/badge/CNCF%20Landscape-5699C6[CNCF LANDSCAPE]]

TIP: The xref:tutorials/tutorial.adoc[tutorial] gives you a glimpse into K8up. Give it a try!

Expand Down

0 comments on commit faf3001

Please sign in to comment.