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

Do another pass over the Quickstart #20

Closed
joeduffy opened this issue Nov 13, 2017 · 8 comments
Closed

Do another pass over the Quickstart #20

joeduffy opened this issue Nov 13, 2017 · 8 comments
Assignees
Labels
area/docs Improvements or additions to documentation customer/feedback Feedback from customers
Milestone

Comments

@joeduffy
Copy link
Member

A bit of feedback from customers on the M8.1 Quickstart docs:

There is a typo on the first page: it says to yarn link @pulumi/pulumi-cloud, but that should be @pulumi/cloud.

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.

@joeduffy joeduffy added the area/docs Improvements or additions to documentation label Nov 13, 2017
@joeduffy joeduffy added this to the 0.9 milestone Nov 13, 2017
@lindydonna
Copy link
Contributor

Agreed. I have some changes ready to go in the devlab branch, so I'll copy those over.

@ericrudder ericrudder added the customer/feedback Feedback from customers label Nov 13, 2017
@ericrudder
Copy link
Member

@lindydonna ... we chatted this morning in the standup ... Joe has some feedback for you on overall mixing of "intro" v. "example" that i will let him share ... Luke pointed out that we now don't have a lambda in the walkthru which seems like we should fix ... and my personal issue is that i want to make sure that the prose covers the new cli improvements, specifically around "resource" and "logs" ... LMK if none of these makes sense ... for now i just wanted to write this down.

@lindydonna
Copy link
Contributor

@ericrudder Thanks, makes perfect sense.

@joeduffy Can you tell me which issues are the most critical to fix for our customer this week?

@joeduffy
Copy link
Member Author

@lindydonna per our brief discussion, I think we are good for now. Maybe schedule a quick post-M9 (M9.1) pass over them to bring them up to code and incorporate feedback?

@lindydonna lindydonna modified the milestones: 0.9, 0.10 Nov 28, 2017
@lindydonna
Copy link
Contributor

I handled the biggest issues already, so this is tracking the bigger pieces of feedback that I got from Joe and Luke. As such, moving to M10 since I won't get it done in time.

@lindydonna
Copy link
Contributor

@joeduffy Reading the issue again, it looks like you were asking for more tactical fixes. I think I fixed the flow and errors, but we do need to restructure. Depending on how long M9 stays open, I may be able to get it done in time. If not, it'll be one of my top priorities for M10.

@joeduffy
Copy link
Member Author

Since we made a fair number of changes throughout M9, I propose we do another pass this week. So pulling back to M9.1.

@lindydonna
Copy link
Contributor

I'm closing this issue to cover the tactical fixes to the quickstart for release 0.9.2, covered by PR #44.

I've created some new issues!

shughes26 added a commit that referenced this issue Jun 12, 2024
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 customer/feedback Feedback from customers
Projects
None yet
Development

No branches or pull requests

3 participants