From a4fbd1460936ce4f63a0fb911852c7578486591e Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Thu, 29 Nov 2018 13:35:14 -0800 Subject: Add anchors for l10n Also remove REFERENCE.md relative link. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 792d065..1e87e51 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,15 @@ 3. [Limitations - OS compatibility, etc.](#limitations) 4. [Development - Guide for contributing to the module](#development) + ## Description Install and manage `cron` resources. + ## Reference -Please see [`REFERENCE.md`](REFERENCE.md) for the reference documentation. +Please see REFERENCE.md for the reference documentation. This module is documented using Puppet Strings. @@ -29,10 +31,12 @@ bundle exec puppet strings generate ./lib/**/*.rb 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. -- cgit v1.2.3