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

Update the documentation / readme #54

Open
lpuskas opened this issue Jun 6, 2018 · 2 comments · Fixed by #64
Open

Update the documentation / readme #54

lpuskas opened this issue Jun 6, 2018 · 2 comments · Fixed by #64
Assignees

Comments

@lpuskas
Copy link
Member

lpuskas commented Jun 6, 2018

  • add sections / document newly added providers
  • document required configuration (env vars)
@martonsereg
Copy link
Member

The documentation still doesn't contain anything about how to setup a Vault instance that is able to handle token management, how to start Pipeline and get a valid token, and what is a token signing key and how do I get one.
If there are descriptions about these in other readmes then links are perfectly fine, but the current documentation still falls short of being a proper resource to start an authentication-enabled Telescopes API in a few minutes.

@lpuskas
Copy link
Member Author

lpuskas commented Jun 25, 2018

Pipeline / Vault setup description:

https://github.com/banzaicloud/pipeline/blob/master/docs/github-app.md

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

Successfully merging a pull request may close this issue.

2 participants