Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify README around using Awsaml vs. setting up an identity provider for Awsaml #16

Closed
fmitchell-r7 opened this issue Mar 1, 2016 · 0 comments

Comments

@fmitchell-r7
Copy link
Contributor

New users have expressed some confusion around running Awsaml. People think they need to set up an identity provider (like Okta) and configure their Amazon account before they can download the binary and run it. We should split the README out into separate documents that cover running Awsaml as a user vs. setting up an identity provider for use with Awsaml. This will also lay the groundwork for being able to provide documentation around identity providers beyond Okta.

Documentation should be Markdown formatted and go into a "docs" folder in the root. The following is probably a good starting point

  • docs/usage.md - Covers how to get binaries and run Awsaml
  • docs/setup.md - Covers how to get set up an identity provider

The README can then be amended with links to the individual documents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

No branches or pull requests

2 participants