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 quickstart doc for porter configuration file #2038

Merged
merged 3 commits into from
Apr 28, 2022

Conversation

VinozzZ
Copy link
Contributor

@VinozzZ VinozzZ commented Apr 26, 2022

What does this change

This PR adds a new quickstar documentation for porter's configuration file

What issue does it fix

adds documentation #1027

Notes for the reviewer

Preview can be found here: https://deploy-preview-2038--porter.netlify.app/quickstart/configurations/

Checklist

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

  • Comment with /azp run test-porter-release if a magefile or build script was modified
  • Comment with /azp run porter-integration if it's a non-trivial PR

@VinozzZ VinozzZ marked this pull request as ready for review April 26, 2022 22:25
docs/config.toml Outdated Show resolved Hide resolved
docs/content/quickstart/configurations.md Outdated Show resolved Hide resolved
docs/content/quickstart/configurations.md Outdated Show resolved Hide resolved
docs/content/quickstart/configurations.md Outdated Show resolved Hide resolved
try out porter with bundles that contain sensitive data, copy and paste below code into the
configuration file:
```yaml
default-secrets-plugin = "filesystem"
Copy link
Member

Choose a reason for hiding this comment

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

Oops, all of your config examples are TOML, not YAML. Pick which language you'd like to show (I think yaml would be better since porter.yaml is yaml too), and then update the code fence / examples to match.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should be fixed

docs/content/quickstart/configurations.md Outdated Show resolved Hide resolved
docs/content/quickstart/configurations.md Outdated Show resolved Hide resolved
docs/content/quickstart/configurations.md Outdated Show resolved Hide resolved
@VinozzZ
Copy link
Contributor Author

VinozzZ commented Apr 27, 2022

/azp run porter-integration

@azure-pipelines
Copy link

Commenter does not have sufficient privileges for PR 2038 in repo getporter/porter

Signed-off-by: Yingrong Zhao <[email protected]>
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.

Just some real small fixups and this is good to go! 🏇 💨

docs/content/quickstart/configuration.md Outdated Show resolved Hide resolved
docs/content/quickstart/configuration.md Outdated Show resolved Hide resolved
Signed-off-by: Yingrong Zhao <[email protected]>
@VinozzZ VinozzZ requested a review from carolynvs April 28, 2022 21:49
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.

LGTM

@carolynvs carolynvs merged commit d7a7995 into getporter:release/v1 Apr 28, 2022
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