pulumi / docs

All things Pulumi docs!
https://pulumi.com
Apache License 2.0
125 stars 220 forks source link

Can’t find docs for bootstrapping new users #11728

Open aviflax opened 2 years ago

aviflax commented 2 years ago

Hi, I’m helping a team switch from Terraform to Pulumi.

As part of that work I’ve converted the code for a Terraform project to Pulumi code.

Now I’m writing the docs for this Pulumi program, and I can’t seem to find a concise but hands-on tutorial or introduction to Pulumi that would give a little bit of the concepts and structure but also some workflow.

For example, I’m imagining the perfect page that I’d like to link to might include:

I hope that makes sense.

If such a document exists, please point me to it.

BTW, I find it odd that when I click the link Tutorials under the User Guides section of the docs site, it takes me to https://www.pulumi.com/registry/ — that doesn’t look like a set of tutorials? Am I missing something?

Thanks!

leezen commented 2 years ago

A quick explanation of what a project is vs a stack

https://www.pulumi.com/docs/intro/concepts/ has concept pages on both projects and stacks. There's also https://www.pulumi.com/docs/guides/organizing-projects-stacks/

A walkthrough of the workflow for getting up and running as a new user of Pulumi in an existing Pulumi project

I can't think of an example for starting from an existing project. I think the closest might be the getting started flows which walk through up, preview, etc. https://www.pulumi.com/docs/get-started/aws/

BTW, I find it odd that when I click the link Tutorials under the User Guides section of the docs site, it takes me to pulumi.com/registry — that doesn’t look like a set of tutorials? Am I missing something?

Thanks for pointing out the lack of feedback on this. We've moved the tutorials into the "How-to Guides" under each provider.

susanev commented 2 years ago

@aviflax thank you so much for all of this feedback!!

as @leezen mentioned you can now find the tutorials after navigating to a package page from the registry landing page. we will be removing the tutorials link from the left nav of the docs soon to avoid future confusion (https://github.com/pulumi/registry/pull/419).

im going to move this over to pulumi-hugo and work on figuring out how we can address the core of the rest of your feedback.

aviflax commented 2 years ago

Thank you!