mirror of
https://github.com/GeekOops/doc.git
synced 2024-05-20 05:12:21 +00:00
Add a contribute and idea page
This commit is contained in:
parent
4b0eb94e11
commit
f359d6fc70
33
content/pages/contribute.md
Normal file
33
content/pages/contribute.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: Contribute
|
||||
description: Description on how to contribute to the geekoops project
|
||||
date: 2022-06-29T13:37:02+02:00
|
||||
Lastmod: 2022-06-29T13:37:02+02:00
|
||||
|
||||
---
|
||||
# How can I contribute?
|
||||
|
||||
GeekOops is an open community project, i.e. everyone is welcome to improve existing roles or submit new repositories that fit the general idea.
|
||||
|
||||
The project is managed on [github](https://github.com/GeekOops). You can contribute by
|
||||
|
||||
* Creating issues on individual roles
|
||||
* Creating Pull Requests to improve existing roles
|
||||
* Push a new repository
|
||||
|
||||
Because the number of participants is still low we don't have a hangout place yet but this might change over time.
|
||||
|
||||
## Pushing a new repository
|
||||
|
||||
The project is open for submission of new automation recipes. For now it consists mostly of ansible roles but submissions that fit the general idea of generic sysop/devops building blocks are more than welcome.
|
||||
|
||||
New submissions must fulfill two requirements to be accepted:
|
||||
|
||||
1. Fit into the general idea of the project
|
||||
2. The role must contain some form of automatic testing (with exceptions)
|
||||
|
||||
Exceptions to the automatic testing rule can be that the role cannot be (efficiently) tested or that testing does not make sense. Exceptions are allowed but must be justifiable.
|
||||
|
||||
### Becoming a geekoops member
|
||||
|
||||
Ask to become a member by [creating a new issue](https://github.com/GeekOops/geekoops/issues/new) in the geekoops repository.
|
24
content/pages/idea.md
Normal file
24
content/pages/idea.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: Idea
|
||||
description: Presentation of the general idea of geekoops
|
||||
date: 2022-06-29T13:49:31+02:00
|
||||
Lastmod: 2022-06-29T13:49:31+02:00
|
||||
|
||||
---
|
||||
geekoops is a collection of generic devops and sysops recipes with a strong focus on the openSUSE distribution. The main idea is to provide tested and simple-to-use building blocks for system administrator and engineers to easily setup and maintain their systems.
|
||||
|
||||
I started this project during the [SUSE Hackweek 20](https://hackweek.suse.com/20/projects/create-ansible-roles-for-generic-server-stuff) based on a personal need for some generic and easy-to-use ansible roles. The project was born from the believe that many more people have the same need and building something publicly available might help the one or another person in fulfilling its daily job.
|
||||
|
||||
## Simplicity is key
|
||||
|
||||
The core idea is to build re-usable and simple deployment recipes that work well together but are loosely coupled. Simplicity is favored over feature completeness, and automated testing heavily encourage to ensure that the project remains healthy over time.
|
||||
|
||||
Often some commonly used ansible support many configuration parameters and scenarios but do not work well together with openSUSE. Many moving parts means many corner cases and often those roles do not work well on openSUSE distributions, because either something missing or something is configured just different enough to make the orchestration tools stumble.
|
||||
|
||||
This is what geekoops wants to make different: The recipes here have a focus on openSUSE but should remain simple enough, so that they should work on other distributions as well or at least lower the threshold of making them work with other distributions.
|
||||
|
||||
Simplicity often is a synonymous for maintainability and a key ingredient to pass the test of time.
|
||||
|
||||
in a nutshell:
|
||||
|
||||
> geekoops heavily encourages the keep-it-simple-stupid principle
|
Loading…
Reference in a new issue