cdist-contrib/README.md

56 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2020-04-21 06:02:51 +00:00
# cdist-contrib
2020-04-26 17:19:31 +00:00
This project extends the [cdist][cdist] configuration management
2020-04-21 06:02:51 +00:00
tool with community-maitained types which are either too specific to fit/be
maintained in cdist itself or were not accepted in code cdist but could still
be useful.
2020-05-07 06:44:45 +00:00
This project does not have releases and is continously updated: see
`CHANGELOG.md` for details.
2020-04-26 17:19:31 +00:00
## Using cdist-contrib
We would recommend that you clone this repository next to your regular cdist
config directory, then setup `conf_dir` with relative paths in
[cdist configuration][cdistconfig].
An example of this would be:
```ini
# contents of cdist.cfg next to cdist-contrib
[GLOBAL]
# Notice that types defined in last dir win and can override native types.
# Consider using a prefix for your own types to avoid collisions.
conf_dir = cdist-contrib:cdist-private
```
And you would run [cdist][cdist] from the same directory as follows:
cdist config -g cdist.cfg
# Or setup your CDIST_CONFIG_FILE environment variable and run as usual
## Participating in the [cdist][cdist] community
Join us on [#cdist:ungleich.ch][cdistmatrix] on matrix or on
[#cdist over mattermost][cdistmattermost].
[cdist]: https://www.cdi.st/
[cdistconfig]: https://www.cdi.st/manual/latest/cdist-configuration.html
[cdistmatrix]: https://matrix.to/#/#cdist:ungleich.ch
[cdistmattermost]: https://chat.ungleich.ch/ungleich/channels/cdist
2020-05-07 06:45:21 +00:00
## Contributing
The preferred way to submit patches is by opening Merge Requests against the
[cdist-contrib project on
code.ungleich.ch](https://code.ungleich.ch/ungleich-public/cdist-contrib) (you
can make an account on
[account.ungleich.ch](https://account.ungleich.ch/).
2020-05-07 06:45:21 +00:00
Every type in cdist-contrib must:
* Have a `man.rst` documentation page.
* Pass [shellcheck](http://shellcheck.net/) without errors.