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

Improve credentials documentation #1651

Merged
merged 1 commit into from
Jun 30, 2021
Merged

Conversation

carolynvs
Copy link
Member

@carolynvs carolynvs commented Jun 29, 2021

What does this change

  • Add quickstart for credentials
  • Clarify the credentials page based on questions we have received
  • Add a crede faq about how to export and use a credential set
  • Add an example bundle that demonstrates credential sets

https://deploy-preview-1651--porter.netlify.app/quickstart/credentials/
https://deploy-preview-1651--porter.netlify.app/credentials/

Other pages are affected, mostly to add links to the updated docs.

What issue does it fix

Part of #1513

Notes for the reviewer

I feel like the docs need to be completely rewritten in a lot of places. But I don't have time to do that so I'm just filling in gaps based on the questions I'm getting on slack.

Checklist

  • Unit Tests
  • Documentation
  • Schema (porter.yaml)

* Add quickstart for credentials
* Clarify the credentials page based on questions we have received
* Add a crede faq about how to export and use a credential set
* Add an example bundle that demonstrates credential sets

Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
@carolynvs carolynvs marked this pull request as ready for review June 29, 2021 21:07
Copy link
Member

@vdice vdice left a comment

Choose a reason for hiding this comment

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

Very helpful, clear and concise overview of credentials! LGTM.

@carolynvs carolynvs merged commit bb16420 into getporter:main Jun 30, 2021
@carolynvs carolynvs deleted the creds-tutorial branch June 30, 2021 16:27
@carolynvs carolynvs mentioned this pull request Jun 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants