aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMelissa <melissa@puppet.com>2018-11-29 14:16:46 -0800
committerGitHub <noreply@github.com>2018-11-29 14:16:46 -0800
commit5f1c90926fd3d98249897066127be7c216bdf440 (patch)
tree1069b3e332c21f6f84932bf8b88d9d4ceaae5867
parent973e0cdcff5670e3cbf3bd77cc6a735009fa3bc5 (diff)
parent680f03ecf3a972a8168a23db64f7d85828da46e5 (diff)
downloadpuppet-sshkeys_core-5f1c90926fd3d98249897066127be7c216bdf440.tar.gz
puppet-sshkeys_core-5f1c90926fd3d98249897066127be7c216bdf440.tar.bz2
Merge pull request #14 from puppetlabs/anchors
Add anchors for l10n
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index da5e668..009ff0f 100644
--- a/README.md
+++ b/README.md
@@ -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.