Skip to content

Commit

Permalink
Fix Markdown lists, ignore Jekyll sites, empty dir
Browse files Browse the repository at this point in the history
  • Loading branch information
Dominic Cleal committed Dec 2, 2012
1 parent 98e20fd commit 10249b4
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 38 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -4,6 +4,9 @@ coverage
.librarian/
.tmp/
modules/
_site/
spec/fixtures/manifests
spec/fixtures/modules

## MAC OS
.DS_Store
Expand Down
26 changes: 13 additions & 13 deletions README.md
Expand Up @@ -46,21 +46,21 @@ below and `puppet doc -r type` output.

The following builtin types have an Augeas-based provider implemented:

* `host`
* `mailalias`
* `host`
* `mailalias`

The following other types have a provider implemented:

* `mounttab` from [puppetlabs-mount_providers](http://forge.puppetlabs.com/puppetlabs/mount_providers)
* `mounttab` from [puppetlabs-mount_providers](http://forge.puppetlabs.com/puppetlabs/mount_providers)

The module adds the following new types:

* `kernel_parameter` for adding kernel parameters to GRUB Legacy or GRUB 2 configs
* `nrpe_command` for setting command entries in Nagios NRPE's `nrpe.cfg`
* `sshd_config` for setting configuration entries in OpenSSH's `sshd_config`
* `sshd_config_subsystem` for setting subsystem entries in OpenSSH's `sshd_config`
* `sysctl` for entries inside Linux's sysctl.conf
* `syslog` for entries inside syslog.conf
* `kernel_parameter` for adding kernel parameters to GRUB Legacy or GRUB 2 configs
* `nrpe_command` for setting command entries in Nagios NRPE's `nrpe.cfg`
* `sshd_config` for setting configuration entries in OpenSSH's `sshd_config`
* `sshd_config_subsystem` for setting subsystem entries in OpenSSH's `sshd_config`
* `sysctl` for entries inside Linux's sysctl.conf
* `syslog` for entries inside syslog.conf

## Requirements

Expand Down Expand Up @@ -89,13 +89,13 @@ loads them.

The following builtin types have Augeas-based providers planned:

* `ssh_authorized_key`
* `port`, once [#5660](http://projects.puppetlabs.com/issues/5660) is done
* `yumrepo`, once [#8758](http://projects.puppetlabs.com/issues/8758) is done
* `ssh_authorized_key`
* `port`, once [#5660](http://projects.puppetlabs.com/issues/5660) is done
* `yumrepo`, once [#8758](http://projects.puppetlabs.com/issues/8758) is done

Other ideas for new types are:

* `/etc/system` types
* `/etc/system` types

## Issues

Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Expand Up @@ -6,7 +6,7 @@ examples.md: examples_header.md examples/*.md
cat examples_header.md > examples.md
for f in examples/*.md; do \
f=`basename $$f .md` ; \
echo " * [$$f provider](#$$f-provider)" ; \
echo "* [$$f provider](#$$f-provider)" ; \
done >> examples.md
echo >> examples.md
cat examples/*.md >> examples.md
Expand Down
12 changes: 6 additions & 6 deletions docs/index.md
@@ -1,14 +1,14 @@
# augeasproviders documentation index

* [README](README.html) - overview, pre-reqs and project information
* [Manifest examples](examples.html) - many examples of each type/provider
* [MotW post](motw.html) - introductory Module of the Week blog post
* [README](README.html) - overview, pre-reqs and project information
* [Manifest examples](examples.html) - many examples of each type/provider
* [MotW post](motw.html) - introductory Module of the Week blog post

Developer docs:

* [CHANGELOG](CHANGELOG.html) - list of changes in each version
* [CONTRIBUTING](CONTRIBUTING.html) - information for would-be contributors
* [Testing techniques](specs.html) - methods used to write provider tests
* [CHANGELOG](CHANGELOG.html) - list of changes in each version
* [CONTRIBUTING](CONTRIBUTING.html) - information for would-be contributors
* [Testing techniques](specs.html) - methods used to write provider tests

_CSS is provided by Ryan Gray's
[buttondown](https://github.com/ryangray/buttondown)._
36 changes: 18 additions & 18 deletions docs/motw.md
Expand Up @@ -4,10 +4,10 @@ _The following blog post was written in November 2012, so may be out of date in
places. Originally published
[here](http://puppetlabs.com/blog/module-of-the-week-domclealaugeasproviders/)._

* Purpose: A set of providers and types that use Augeas to modify config files
* Module: [domcleal/augeasproviders](http://forge.puppetlabs.com/domcleal/augeasproviders)
* Puppet Version: 0.25+
* Platforms: Any with ruby-augeas available (Linux, BSD, Solaris, AIX)
* Purpose: A set of providers and types that use Augeas to modify config files
* Module: [domcleal/augeasproviders](http://forge.puppetlabs.com/domcleal/augeasproviders)
* Puppet Version: 0.25+
* Platforms: Any with ruby-augeas available (Linux, BSD, Solaris, AIX)

[Augeas](http://augeas.net) is a library and API for accessing and modifying text configuration files, with a [number of language bindings](http://www.augeas.net/download.html) and [over a hundred](http://git.fedorahosted.org/cgit/augeas.git/tree/lenses) common config formats supported. It emphasises safety (not breaking files) and preservation of a file's existing layout and formatting.

Expand All @@ -21,8 +21,8 @@ The module is written by a couple of Augeas developers, with the aim of making t


## Installing the module
* Complexity: Medium
* Installation Time: 5 minutes
* Complexity: Medium
* Installation Time: 5 minutes

Installing the `augeasproviders` module can be done with the Puppet module tool, available in Puppet 2.7.14+ and Puppet Enterprise 2.5+, and also available as a RubyGem:

Expand All @@ -47,22 +47,22 @@ The ruby-augeas language bindings need to be installed on the client for the sam

The module only consists of custom types and providers, stored under `lib/puppet/type/` and `lib/puppet/provider/` respectively inside the module. As of version 0.4.0, these new types are:

* `nrpe_command` for setting command entries in Nagios NRPE's `nrpe.cfg`
* `sshd_config` for setting configuration entries in OpenSSH's `sshd_config`
* `sshd_config_subsystem` for setting subsystem entries in OpenSSH's `sshd_config`
* `sysctl` for entries inside Linux's `sysctl.conf`
* `syslog` for entries inside `syslog.conf`
* `nrpe_command` for setting command entries in Nagios NRPE's `nrpe.cfg`
* `sshd_config` for setting configuration entries in OpenSSH's `sshd_config`
* `sshd_config_subsystem` for setting subsystem entries in OpenSSH's `sshd_config`
* `sysctl` for entries inside Linux's `sysctl.conf`
* `syslog` for entries inside `syslog.conf`

And the following existing types have Augeas-based providers added:

* `host`
* `mailalias`
* `mounttab` from [puppetlabs-mount_providers](http://forge.puppetlabs.com/puppetlabs/mount_providers)
* `host`
* `mailalias`
* `mounttab` from [puppetlabs-mount_providers](http://forge.puppetlabs.com/puppetlabs/mount_providers)


## Configuring the module
* Complexity: Easy
* Configuration Time: 1 minute
* Complexity: Easy
* Configuration Time: 1 minute

The new types need no configuration and can be used immediately.

Expand Down Expand Up @@ -138,5 +138,5 @@ Some of the other new types planned are `kernel_parameter` to manage Linux kerne

## Learn More:

* [domcleal-augeasproviders](http://forge.puppetlabs.com/domcleal/augeasproviders)
* [GitHub: augeasproviders](https://github.com/hercules-team/augeasproviders)
* [domcleal-augeasproviders](http://forge.puppetlabs.com/domcleal/augeasproviders)
* [GitHub: augeasproviders](https://github.com/hercules-team/augeasproviders)

0 comments on commit 10249b4

Please sign in to comment.