]> gitweb.fluxo.info Git - puppet-sshkeys_core.git/commitdiff
Add anchors for l10n
authorJosh Cooper <josh@puppet.com>
Thu, 29 Nov 2018 22:00:52 +0000 (14:00 -0800)
committerJosh Cooper <josh@puppet.com>
Thu, 29 Nov 2018 22:00:52 +0000 (14:00 -0800)
Also remove relative link.

README.md

index da5e668eb541cb502c4c75feeed791beb5e59ac9..009ff0fef108da0a2b77e9e9059f1d2425bdf882 100644 (file)
--- 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.