diff --git a/README.md b/README.md index f59af12..ca56f87 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ -[![Puppet Forge Version](http://img.shields.io/puppetforge/v/herculesteam/augeasproviders_syslog.svg)](https://forge.puppetlabs.com/herculesteam/augeasproviders_syslog) -[![Puppet Forge Downloads](http://img.shields.io/puppetforge/dt/herculesteam/augeasproviders_syslog.svg)](https://forge.puppetlabs.com/herculesteam/augeasproviders_syslog) -[![Puppet Forge Endorsement](https://img.shields.io/puppetforge/e/herculesteam/augeasproviders_syslog.svg)](https://forge.puppetlabs.com/herculesteam/augeasproviders_syslog) -[![Build Status](https://img.shields.io/travis/hercules-team/augeasproviders_syslog/master.svg)](https://travis-ci.org/hercules-team/augeasproviders_syslog) -[![Coverage Status](https://img.shields.io/coveralls/hercules-team/augeasproviders_syslog.svg)](https://coveralls.io/r/hercules-team/augeasproviders_syslog) -[![Gemnasium](https://img.shields.io/gemnasium/hercules-team/augeasproviders_syslog.svg)](https://gemnasium.com/hercules-team/augeasproviders_syslog) -[![Sponsor](https://img.shields.io/badge/%E2%99%A5-Sponsor-hotpink.svg)](https://github.com/sponsors/raphink) +# syslog: types/providers for syslog files for Puppet +[![License](https://img.shields.io/github/license/voxpupuli/puppet-augeasproviders_syslog.svg)](https://github.com/voxpupuli/puppet-augeasproviders_syslog/blob/master/LICENSE) +[![Puppet Forge Version](http://img.shields.io/puppetforge/v/puppet/augeasproviders_syslog.svg)](https://forge.puppetlabs.com/puppet/augeasproviders_syslog) +[![Puppet Forge Downloads](http://img.shields.io/puppetforge/dt/puppet/augeasproviders_syslog.svg)](https://forge.puppetlabs.com/puppet/augeasproviders_syslog) +[![Build Status](https://github.com/voxpupuli/puppet-augeasproviders_syslog/workflows/CI/badge.svg)](https://github.com/voxpupuli/puppet-augeasproviders_syslog/actions?query=workflow%3ACI) +[![Donated by Herculesteam](https://img.shields.io/badge/donated%20by-herculesteam-fb7047.svg)](#transfer-notice) -# syslog: types/providers for syslog files for Puppet +# Features This module provides new types/providers for Puppet to read and modify syslog config files using the Augeas configuration library. @@ -60,7 +59,7 @@ rsyslog\_filter (augeas) | no | **yes** | **yes** | **yes** | ## Documentation and examples Type documentation can be generated with `puppet doc -r type` or viewed on the -[Puppet Forge page](http://forge.puppetlabs.com/herculesteam/augeasproviders_syslog). +[Puppet Forge page](http://forge.puppetlabs.com/voxpupuli/augeasproviders_syslog). A `syslog` provider handles basic syslog configs, while an `rsyslog` provider handles the extended rsyslog config (this requires Augeas 1.0.0). @@ -162,4 +161,35 @@ handles the extended rsyslog config (this requires Augeas 1.0.0). ## Issues -Please file any issues or suggestions [on GitHub](https://github.com/hercules-team/augeasproviders_syslog/issues). +Please file any issues or suggestions [on GitHub](https://github.com/voxpupuli/augeasproviders_syslog/issues). + +## Supported OS + +See [metadata.json](metadata.json) for supported OS versions. + +## Dependencies + +See [metadata.json](metadata.json) for dependencies. + +## Puppet + +The supported Puppet versions are listed in the [metadata.json](metadata.json) + +## REFERENCES + +Please see [REFERENCE.md](https://github.com/voxpupuli/puppet-augeasproviders_syslog/blob/master/REFERENCE.md) for more details. + +## Contributing + +Please report bugs and feature request using [GitHub issue +tracker](https://github.com/voxpupuli/puppet-augeasproviders_syslog/issues). + +For pull requests, it is very much appreciated to check your Puppet manifest +with [puppet-lint](https://github.com/puppetlabs/puppet-lint/) to follow the recommended Puppet style guidelines from the +[Puppet Labs style guide](https://www.puppet.com/docs/puppet/latest/style_guide.html). + +## Transfer Notice + +This plugin was originally authored by [Hercules Team](https://github.com/hercules-team). +The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance. +Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Hercules Team. diff --git a/metadata.json b/metadata.json index 5a66b99..3a41bd5 100644 --- a/metadata.json +++ b/metadata.json @@ -1,12 +1,12 @@ { - "name": "herculesteam-augeasproviders_syslog", + "name": "puppet-augeasproviders_syslog", "version": "2.3.0", - "author": "Raphael Pinson", + "author": "Vox Pupuli", "summary": "Augeas-based syslog type and providers for Puppet", "license": "Apache-2.0", - "source": "https://github.com/hercules-team/augeasproviders_syslog", - "project_page": "https://github.com/hercules-team/augeasproviders_syslog", - "issues_url": "https://github.com/hercules-team/augeasproviders_syslog/issues", + "source": "https://github.com/voxpupuli/puppet-augeasproviders_syslog", + "project_page": "https://github.com/voxpupuli/puppet-augeasproviders_syslog", + "issues_url": "https://github.com/voxpupuli/puppet-augeasproviders_syslog/issues", "description": "This module provides type/providers for syslog using the Augeas configuration API library.", "dependencies": [ {