Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit b984cad

Browse files
authoredMar 13, 2024
Fill basic project information (#17)
demo: https://github.com/aenix-io/etcd-operator/tree/basic-readme fixes #10 Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
1 parent 57c8ece commit b984cad

File tree

5 files changed

+122
-0
lines changed

5 files changed

+122
-0
lines changed
 

‎ADOPTERS.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Adopters
2+
3+
Below you can find a list of organizations and users who have agreed to
4+
tell the world that they are using etcd-operator in a production environment.
5+
6+
The goal of this list is to inspire others to do the same and to grow
7+
this open source community and project.
8+
9+
Please add your organization to this list. It takes 5 minutes of your time,
10+
but it means a lot to us.
11+
12+
## Updating this list
13+
14+
To add your organization to this list, you can either:
15+
16+
- [open a pull request](https://github.com/aenix-io/cozystack/pulls) to directly update this file, or
17+
- [edit this file](https://github.com/aenix-io/cozystack/blob/main/ADOPTERS.md) directly in GitHub
18+
19+
Feel free to ask in the Slack chat if you any questions and/or require
20+
assistance with updating this list.
21+
22+
## etcd-operator Adopters
23+
24+
This list is sorted in chronological order, based on the submission date.
25+
26+
| Organization | Contact | Date | Description of Use |
27+
| ------------ | ------- | ---- | ------------------ |

‎CODE_OF_CONDUCT.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Code of Conduct
2+
3+
etcd-operator follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

‎CONTRIBUTING.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to etcd-operator
2+
3+
Welcome! We are glad that you want to contribute to our etcd-operator project! 💖
4+
5+
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:
6+
7+
* Problems found while setting up the development environment
8+
* Gaps in our documentation
9+
* Bugs in our Github actions
10+
11+
First, though, it is important that you read the [code of conduct](CODE_OF_CONDUCT.md).
12+
13+
The guidelines below are a starting point. We don't want to limit your
14+
creativity, passion, and initiative. If you think there's a better way, please
15+
feel free to bring it up in a Github discussion, or open a pull request. We're
16+
certain there are always better ways to do things, we just need to start some
17+
constructive dialogue!
18+
19+
## Ways to contribute
20+
21+
We welcome many types of contributions including:
22+
23+
* New features
24+
* Builds, CI/CD
25+
* Bug fixes
26+
* Documentation
27+
* Issue Triage
28+
* Answering questions on Slack or Github Discussions
29+
* Web design
30+
* Communications / Social Media / Blog Posts
31+
* Events participation
32+
* Release management
33+
34+
## Ask for Help
35+
36+
The best way to reach us with a question when contributing is to drop a line in
37+
our [Telegram channel](https://t.me/etcd_operator), or start a new Github discussion.
38+
39+
## Raising Issues
40+
41+
When raising issues, please specify the following:
42+
43+
- A scenario where the issue occurred (with details on how to reproduce it)
44+
- Errors and log messages that are displayed by the involved software
45+
- Any other detail that might be useful

‎MAINTAINERS.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# The etcd-operator Maintainers
2+
3+
| Maintainer | GitHub Username | Company |
4+
| ---------- | --------------- | ------- |
5+
| Andrei Kvapil | [@kvaps](https://github.com/kvaps) | Ænix |
6+
| George Gaál | [@gecube](https://github.com/gecube) | Ænix |
7+
| Kirill | [@sircthulhu](https://github.com/sircthulhu) | |
8+
| Alex Gluck | [@AlexGluck](https://github.com/AlexGluck) | |
9+
| Oleg Kunitsyn | [@hiddenmarten](https://github.com/hiddenmarten) | |

‎README.md

+38
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
1+
<img src="https://github.com/cncf/artwork/raw/main/projects/etcd/horizontal/color/etcd-horizontal-color.svg#gh-light-mode-only" height="100">
2+
<img src="https://github.com/cncf/artwork/raw/main/projects/etcd/horizontal/white/etcd-horizontal-white.svg#gh-dark-mode-only" height="100">
3+
4+
[![Open Source](https://img.shields.io/badge/Open-Source-brightgreen)](https://opensource.org/)
5+
[![Apache-2.0 License](https://img.shields.io/github/license/aenix-io/etcd-operator)](https://opensource.org/licenses/)
6+
[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=flat&logo=telegram&logoColor=white)](https://t.me/etcd-operator)
7+
[![Active](http://img.shields.io/badge/Status-Active-green.svg)](https://aenix.io/etcd-operator/)
8+
[![GitHub Release](https://img.shields.io/github/release/aenix-io/etcd-operator.svg?style=flat)](https://github.com/aenix-io/etcd-operator)
9+
[![GitHub Commit](https://img.shields.io/github/commit-activity/y/aenix-io/etcd-operator)](https://github.com/aenix-io/etcd-operator)
10+
111
# etcd-operator
12+
213
New generation community-driven etcd-operator!
14+
15+
**etcd-operator** is a project aimed at simplifying the deployment and management of the etcd clusters within a Kubernetes environment.
16+
It simplifies operations such as deployment, scaling, and disaster recovery through Kubernetes custom resources, enabling easy configuration and management via YAML files.
17+
18+
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.
19+
20+
## Versioning
21+
22+
Versioning adheres to the [Semantic Versioning](http://semver.org/) principles.
23+
A full list of the available releases is available in the GitHub repository's [Release](https://github.com/aenix-io/etcd-operator/releases) section.
24+
25+
## Contributions
26+
27+
Contributions are highly appreciated and very welcomed!
28+
29+
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.
30+
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.
31+
32+
You can express your intention in working on the fix on your own.
33+
Commits are used to generate the changelog, and their author will be referenced in it.
34+
35+
In case of **Feature Requests** please use the [Discussion's Feature Request section](https://github.com/aenix-io/etcd-operator/discussions/categories/feature-requests).
36+
37+
## License
38+
39+
etcd-operator is licensed under Apache 2.0.
40+
The code is provided as-is with no warranties.

0 commit comments

Comments
 (0)
Please sign in to comment.