Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fill basic project information #17

Merged
merged 1 commit into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions ADOPTERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Adopters

Below you can find a list of organizations and users who have agreed to
tell the world that they are using etcd-operator in a production environment.

The goal of this list is to inspire others to do the same and to grow
this open source community and project.

Please add your organization to this list. It takes 5 minutes of your time,
but it means a lot to us.

## Updating this list

To add your organization to this list, you can either:

- [open a pull request](https://github.com/aenix-io/cozystack/pulls) to directly update this file, or
- [edit this file](https://github.com/aenix-io/cozystack/blob/main/ADOPTERS.md) directly in GitHub

Feel free to ask in the Slack chat if you any questions and/or require
assistance with updating this list.

## etcd-operator Adopters

This list is sorted in chronological order, based on the submission date.

| Organization | Contact | Date | Description of Use |
| ------------ | ------- | ---- | ------------------ |
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

etcd-operator follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing to etcd-operator

Welcome! We are glad that you want to contribute to our etcd-operator project! 💖

As you get started, you are in the best position to give us feedbacks on areas of our project that we need help with, including:

* Problems found while setting up the development environment
* Gaps in our documentation
* Bugs in our Github actions

First, though, it is important that you read the [code of conduct](CODE_OF_CONDUCT.md).

The guidelines below are a starting point. We don't want to limit your
creativity, passion, and initiative. If you think there's a better way, please
feel free to bring it up in a Github discussion, or open a pull request. We're
certain there are always better ways to do things, we just need to start some
constructive dialogue!

## Ways to contribute

We welcome many types of contributions including:

* New features
* Builds, CI/CD
* Bug fixes
* Documentation
* Issue Triage
* Answering questions on Slack or Github Discussions
* Web design
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Web design? :)

* Communications / Social Media / Blog Posts
* Events participation
* Release management

## Ask for Help

The best way to reach us with a question when contributing is to drop a line in
our [Telegram channel](https://t.me/etcd_operator), or start a new Github discussion.

## Raising Issues

When raising issues, please specify the following:

- A scenario where the issue occurred (with details on how to reproduce it)
- Errors and log messages that are displayed by the involved software
- Any other detail that might be useful
9 changes: 9 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# The etcd-operator Maintainers

| Maintainer | GitHub Username | Company |
| ---------- | --------------- | ------- |
| Andrei Kvapil | [@kvaps](https://github.com/kvaps) | Ænix |
| George Gaál | [@gecube](https://github.com/gecube) | Ænix |
| Kirill | [@sircthulhu](https://github.com/sircthulhu) | |
| Alex Gluck | [@AlexGluck](https://github.com/AlexGluck) | |
| Oleg Kunitsyn | [@hiddenmarten](https://github.com/hiddenmarten) | |
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
<img src="https://github.com/cncf/artwork/raw/main/projects/etcd/horizontal/color/etcd-horizontal-color.svg#gh-light-mode-only" height="100">
<img src="https://github.com/cncf/artwork/raw/main/projects/etcd/horizontal/white/etcd-horizontal-white.svg#gh-dark-mode-only" height="100">

[![Open Source](https://img.shields.io/badge/Open-Source-brightgreen)](https://opensource.org/)
[![Apache-2.0 License](https://img.shields.io/github/license/aenix-io/etcd-operator)](https://opensource.org/licenses/)
[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=flat&logo=telegram&logoColor=white)](https://t.me/etcd-operator)
[![Active](http://img.shields.io/badge/Status-Active-green.svg)](https://aenix.io/etcd-operator/)
[![GitHub Release](https://img.shields.io/github/release/aenix-io/etcd-operator.svg?style=flat)](https://github.com/aenix-io/etcd-operator)
[![GitHub Commit](https://img.shields.io/github/commit-activity/y/aenix-io/etcd-operator)](https://github.com/aenix-io/etcd-operator)

# etcd-operator

New generation community-driven etcd-operator!

**etcd-operator** is a project aimed at simplifying the deployment and management of the etcd clusters within a Kubernetes environment.
It simplifies operations such as deployment, scaling, and disaster recovery through Kubernetes custom resources, enabling easy configuration and management via YAML files.

The etcd-operator is designed for developers and operators looking for a robust solution to handle etcd clusters as part of their Kubernetes applications, offering reliability and ease of use for dynamic, distributed systems.

## Versioning

Versioning adheres to the [Semantic Versioning](http://semver.org/) principles.
A full list of the available releases is available in the GitHub repository's [Release](https://github.com/aenix-io/etcd-operator/releases) section.

## Contributions

Contributions are highly appreciated and very welcomed!

In case of bugs, please, check if the issue has been already opened by checking the [GitHub Issues](https://github.com/aenix-io/etcd-operator/issues) section.
In case it isn't, you can open a new one: a detailed report will help us to replicate it, assess it, and work on a fix.

You can express your intention in working on the fix on your own.
Commits are used to generate the changelog, and their author will be referenced in it.

In case of **Feature Requests** please use the [Discussion's Feature Request section](https://github.com/aenix-io/etcd-operator/discussions/categories/feature-requests).

## License

etcd-operator is licensed under Apache 2.0.
The code is provided as-is with no warranties.