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.

Sign up for GitHub

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

Jump to bottom

Update quickstart; first complete draft of config doc #106

Merged
merged 3 commits into from Mar 12, 2018
Merged

Update quickstart; first complete draft of config doc #106

merged 3 commits into from Mar 12, 2018

Conversation

lindydonna
Copy link
Contributor

@lindydonna lindydonna changed the title Update quickstart, first version of config doc Update quickstart; first complete draft of config doc Mar 10, 2018
chrsmith
chrsmith approved these changes Mar 10, 2018
View reviewed changes
_includes/aws-resource-warning.md Outdated
@@ -0,0 +1 @@
> WARNING: these commands provision resources in your AWS account. If you're not using an account in the [AWS Free Tier](https://aws.amazon.com/free/), you will have charges on your account. If you clean up your resources promptly, these charges should be less than a few dollars, but make sure you're aware of the costs you may incur.
Copy link
Contributor

Choose a reason for hiding this comment

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

"WARNING:" seems a bit too scary. Is there a more gentle tone we can use? For reference, a similar callout is used on GCP docs.

This tutorial has several steps, and each step is documented on its own page. The final page of the tutorial includes instructions for cleaning up resources, so you won't continue to be billed for Cloud Platform services. If you decide not to complete all the steps of the tutorial, see the cleanup instructions on the final page.
https://cloud.google.com/dotnet/docs/getting-started/tutorial-app

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 like that better. Terraform did "warning," so I thought perhaps they had customers who were surprised.

concepts/colada-files.md
@@ -2,7 +2,16 @@
title: "Configuration files"
---

## Pulumi.yaml
## Pulumi.yaml {#pulumi-yaml}
Copy link
Contributor

Choose a reason for hiding this comment

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

What is with the {#pulumi-yaml} syntax? Does that add an id="pulumi-yaml" attribute on the element so we can link to http://.../page#pulumi-yaml? If so, 💯 !!!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed! Perhaps I should add this to the readme, to provide an easy cheatsheet for jekyll.

@lindydonna lindydonna mentioned this pull request Mar 12, 2018
Closed
@lindydonna lindydonna merged commit db09cb0 into master Mar 12, 2018
@lindydonna lindydonna deleted the config-doc branch March 12, 2018 04:36
@lindydonna lindydonna mentioned this pull request Mar 12, 2018
Closed
lindydonna added a commit that referenced this pull request Mar 12, 2018
@lindydonna
Update quickstart; first complete draft of config doc (#106)
d049766 
* Warn that quickstart provisions resources in your account. Closes #45.

* Document configuration settings, including secrets. Closes #45 and #51.

* Make resource "warning" more gentle
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrsmith chrsmith chrsmith approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@lindydonna @chrsmith