From ed9c6e0bde80595451f11f2a361d953765b0fa94 Mon Sep 17 00:00:00 2001 From: Josh Cooper Date: Thu, 29 Nov 2018 13:40:06 -0800 Subject: Add anchors for l10n Also remove relative link. --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 88011b0..5d28bf7 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,17 @@ #### Table of Contents 1. [Description](#description) -2. [Reference](#reference) -3. [Development - Guide for contributing to the module](#development) +2. [Usage](#usage) +3. [Reference](#reference) +4. [Development - Guide for contributing to the module](#development) + ## Description The host_core module is used to manage host entries in a hosts file. For most systems, the hosts file is located in `/etc/hosts`. -### Beginning with host_core + +## Usage To configure a `localhost` host entry to resolve to an `ip` with a list of `host_aliases`, use the following code: @@ -24,9 +27,10 @@ host { 'localhost': } ``` + ## 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. @@ -39,6 +43,7 @@ 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. + ## 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