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 docs with how-to guides in addition to quickstart #46

Closed
2 tasks
lindydonna opened this issue Dec 16, 2017 · 1 comment
Closed
2 tasks

Update docs with how-to guides in addition to quickstart #46

lindydonna opened this issue Dec 16, 2017 · 1 comment
Assignees
Labels
area/docs Improvements or additions to documentation

Comments

@lindydonna
Copy link
Contributor

lindydonna commented Dec 16, 2017

  • Document top-level flows like using TypeScript, etc
  • Document current config precedence

Joe's feedback in #20:

It seems like we ought to have a new section: "So you've got a Pulumi program, and want to build/deploy it, how do I do that?" Everything is geared towards starting from scratch, so there are steps missing. For instance, it should tell you to yarn install, how to find out what to yarn link, how to know what configuration variables to set, etc.

There are other missing steps. For example, it never tells you how to compile your TypeScript which, though orthogonal to our tool, we should do if we're going to use it in our samples.

The layout of the Quickstart pages are a little confusing, because clicking on the link to Quickstart then puts you on a page with many links, including Overview. Why not just start there automatically.

Let's do one more pass over the Quickstart "as a customer would", after the above changes, and ideally from a clean machine, just to make sure we've ironed out all the kinks.

@lindydonna lindydonna self-assigned this Dec 16, 2017
@lindydonna lindydonna added the area/docs Improvements or additions to documentation label Dec 20, 2017
@lindydonna
Copy link
Contributor Author

Closing in favor of #73

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant