Skip to content

README updates: more examples, explain auth methods#73

Merged
natemccurdy merged 1 commit intomasterfrom
readme
Mar 2, 2023
Merged

README updates: more examples, explain auth methods#73
natemccurdy merged 1 commit intomasterfrom
readme

Conversation

@natemccurdy
Copy link
Copy Markdown
Contributor

@natemccurdy natemccurdy commented Mar 2, 2023

Pull Request (PR) description

This updates the readme to improve it in the following ways:

  • Adds examples of using the options hash vs. positional arguments
  • Clarifies each available config option in both the options hash and positional args.
  • Adds Details on supported authentication methods.
  • Fixes a few typos and some inaccurate information.

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.

@natemccurdy natemccurdy added the docs Improvements or additions to documentation label Mar 2, 2023
Comment thread README.md Outdated
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)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aww, bummer.
Are we okay with linking to the web archive?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 🤷 .

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you cannot find an alternative I think the link is fine. also CC @binford2k about the broken link

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Decided to just drop the link.

@natemccurdy natemccurdy merged commit 8bca061 into master Mar 2, 2023
@natemccurdy natemccurdy deleted the readme branch March 2, 2023 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants