Skip to content

Commit

Permalink
Merge pull request #18 from zilchms/metadata
Browse files Browse the repository at this point in the history
Update readme and metadata to facilitate migration
  • Loading branch information
bastelfreak authored Apr 6, 2024
2 parents b95fa13 + d8f74a6 commit 076809a
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 15 deletions.
50 changes: 40 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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.
10 changes: 5 additions & 5 deletions metadata.json
Original file line number Diff line number Diff line change
@@ -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": [
{
Expand Down

0 comments on commit 076809a

Please sign in to comment.