README updates: more examples, explain auth methods #73
Conversation
README.md
Outdated
| than compiled. In this way, the secret data is not embedded in the catalog and | ||
| the Puppetserver does not need permissions to read all your Vault secrets. | ||
|
|
||
| See [this blog | ||
| post](https://puppet.com/blog/secret-agents-man-secrets-store-integrations-puppet-6) |
There was a problem hiding this comment.
Broken link 😞
Available on the internet archive:
https://web.archive.org/web/20220520045735/https://www.puppet.com/blog/secret-agents-man-secrets-store-integrations-puppet-6/
There was a problem hiding this comment.
Aww, bummer.
Are we okay with linking to the web archive?
There was a problem hiding this comment.
Not sure it's the best: to me it looks like promotion of Puppet 6 which was just announced, and now that Puppet 6 is EOL, it has low value maybe? The current documentation should have all the content in a more up-to-date form I believe 🤷 .
There was a problem hiding this comment.
Yup, agreed that that blog post isn't really useful.
I'll either drop this line entirely, or find something more useful to link to.
There was a problem hiding this comment.
if you cannot find an alternative I think the link is fine. also CC @binford2k about the broken link
There was a problem hiding this comment.
Decided to just drop the link.
Pull Request (PR) description
This updates the readme to improve it in the following ways:
This also restructures the README to have requirements first, usage and config examples next, then ends with details on the supported authentication methods.
I think this flow is better because people usually want to see setup info and example usage first. Prior to this, that was buried beneath details about the authentication methods.