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

Add documentation on how credentials work internally #870

Merged
merged 1 commit into from
Jan 29, 2020

Conversation

dev-drprasad
Copy link
Contributor

What does this change

Add documentation on how credentials work internally

What issue does it fix

Related #854

Checklist

  • Documentation

Comment on lines -13 to -14
* What is a mixin
* Snippet of yaml
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I saw there is already enough doc on this. so i removed these

@@ -3,7 +3,7 @@ title: Parameters, Credentials, Outputs, and Images in Porter
description: How to wire parameters, credentials and outputs into steps
---

In the Porter manifest, you can declare both parameters and credentials. In addition to providing a mechanism for declaring parameters and credentials at the bundle level, Porter provides a way to declare how each of these are provided to [mixins](/mixin-architecture). This mechanism is also applicable to declaring how output from one mixin can be passed to another, as well as how to consume parameters, credentials and outputs from bundle dependencies. Finally, you can also use this technique to reference images defined in the `images` section of the manifest.
In the Porter manifest, you can declare both parameters and credentials. In addition to providing a mechanism for declaring parameters and credentials at the bundle level, Porter provides a way to declare how each of these are provided to [mixins][mixin-architecture]. This mechanism is also applicable to declaring how output from one mixin can be passed to another, as well as how to consume parameters, credentials and outputs from bundle dependencies. Finally, you can also use this technique to reference images defined in the `images` section of the manifest.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fix broken /mixin-architecture link

Copy link
Member

@carolynvs carolynvs left a comment

Choose a reason for hiding this comment

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

Thanks for picking this up! 💯 🚀

@carolynvs
Copy link
Member

The page will be live here https://porter.sh/how-credentials-work/ once the PR merges.

@carolynvs carolynvs merged commit 69884f0 into getporter:master Jan 29, 2020
@dev-drprasad dev-drprasad deleted the add-cred-doc branch January 29, 2020 14:59
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