Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.67 KB

README.md

File metadata and controls

52 lines (32 loc) · 2.67 KB
Raw

cron_core

Modules Status Modules Status Modules Status Modules Status

Table of Contents

  1. Description
  2. Reference
  3. Limitations - OS compatibility, etc.
  4. Development - Guide for contributing to the module

Description

Install and manage cron resources.

Reference

Please see REFERENCE.md for the reference documentation.

This module is documented using Puppet Strings.

For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.

To generate documentation locally, run the following command:

bundle install
bundle exec puppet strings generate --format markdown --out REFERENCE.md

This command will create a browsable _index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.

Limitations

cron is not compatible with Windows or Fedora 28.

Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

For more information, see our module contribution guide.