diff options
| -rw-r--r-- | README.md | 7 |
1 files changed, 5 insertions, 2 deletions
@@ -8,10 +8,12 @@ 3. [Reference - User documentation](#reference) 4. [Development - Guide for contributing to the module](#development) +<a id="description"></a> ## Description Manage SSH `authorized_keys`, and `ssh_known_hosts` files. +<a id="usage"></a> ## Usage To manage an authorized key for a user, use the following code: @@ -34,10 +36,10 @@ sshkey { 'github.com': key => 'AAAAB3Nza[...]UFFAaQ==', } ``` - +<a id="reference"></a> ## 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. @@ -50,6 +52,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. +<a id="development"></a> ## 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. |