forked from skonfig/base
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request skonfig#15 from skonfig/4nd3r/update_readme2
update README
- Loading branch information
Showing
1 changed file
with
23 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,30 @@ | ||
# skonfig extra set | ||
|
||
This is a set of extra types for use with the [skonfig](https://skonfig.li) configuration management system. | ||
[skonfig](https://skonfig.li) is a configuration management system forked from [cdist](https://cdi.st) | ||
(after [e250024](https://code.ungleich.ch/ungleich-public/cdist/commit/e2500248f2ddc83129e77f2e6b8dffb64904dbae)). | ||
|
||
Work is mostly split between three main repositories: | ||
We have three main repositories: | ||
|
||
* [skonfig](https://github.com/skonfig/skonfig) - implementation of the **skonfig tool** and quick **getting started** bits, | ||
* [base](https://github.com/skonfig/base) - **base** explorers and types, | ||
* **extra** - **extra** types (community contributions). | ||
* [base](https://github.com/skonfig/base) - explorer and types for **general use**, | ||
* **extra** - **special purpose** types and incubator for new types. | ||
|
||
## base vs extra? | ||
You can find us in `#skonfig:matrix.org` ([matrix?](https://matrix.org/faq/)). | ||
|
||
Explorers and types which are related to changing state of the operating | ||
system or core components of it and are not strictly related to some specific | ||
piece of software, are considered base. | ||
Furthermore, the quality requirements for inclusion in base are higher than for extra. | ||
## Documentation | ||
|
||
Most parts of [cdist documentation](https://www.cdi.st/manual/latest/) apply, but there are differences: | ||
|
||
* `skonfig` does only `config` (see `skonfig -h`), | ||
* some types behave differently and it's recommended to consult manuals in *base* and *extra*. | ||
|
||
## Split between *base* and *extra* | ||
|
||
**Base** explorers and types are used to change the state of the operating | ||
system or core components of it and are not for some specific piece of | ||
software. Furthermore, the quality requirements for inclusion in base are | ||
higher than for extra. | ||
|
||
**Extra** contains types for specific purposes like configuring software or | ||
services which don't belong to the operating system and also serves as an | ||
incubator for new types. |