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 a "cookbook" style recipe page with examples for each supported language #11800

Closed
jen20 opened this issue Oct 22, 2018 · 3 comments
Closed
Assignees
Labels
area/docs Improvements or additions to documentation docs/hackathon docs/intro Content under intro to Pulumi -- architecture & concepts, use cases, etc. grooming-q2y25 kind/enhancement Improvements or new features resolution/fixed This issue was fixed

Comments

@jen20
Copy link
Contributor

jen20 commented Oct 22, 2018

It would be nice to present short, focused examples for common questions in the style of "cookbook" documentation. Some example scenarios to start with:

  • How do I use a data source to look up an existing resource and then use the .get to populate parameters for it?
  • How do I use multiple provider instances?
  • How do I use computed value in control flow?
  • How do I use await when constructing components?
  • How do I transform an unknown value from one component to use as an input for another?

Please feel free to add other questions to the list!

@joeduffy
Copy link
Member

I love this idea -- let's pair up to try to move the needle on some of this during M19, as part of our overall focus on improving overall onboarding documentation.

@joeduffy joeduffy assigned bermudezmt and unassigned jen20 and joeduffy Jul 9, 2019
@bermudezmt bermudezmt added area/docs Improvements or additions to documentation docs/intro Content under intro to Pulumi -- architecture & concepts, use cases, etc. labels Jul 22, 2019
@susanev susanev transferred this issue from pulumi/docs Apr 2, 2022
@lukehoban lukehoban added the kind/enhancement Improvements or new features label Mar 5, 2023
@sean1588 sean1588 transferred this issue from pulumi/pulumi-hugo May 10, 2024
@thoward thoward added the resolution/fixed This issue was fixed label Oct 29, 2024
@thoward thoward moved this from 🧳 Backlog to 🏁 Done in Docs 📚 Oct 29, 2024
@thoward
Copy link
Contributor

thoward commented Oct 29, 2024

Hi @jen20! This is a great idea and we really appreciate the contribution. We've implemented something like this as Tutorials in our docs site. That said, some of the examples described here aren't represented, so I've included them in big list of ideas for tutorials so that we can discuss as a team when we work on the content plan.

We are currently working on grooming the documentation repo backlog and so I'm going to close this ticket. If you think it should be re-opened, please leave a comment here and we can revisit it.

@thoward thoward closed this as completed Oct 29, 2024
@pulumi-bot pulumi-bot reopened this Oct 29, 2024
@pulumi-bot
Copy link
Collaborator

Cannot close issue:

  • does not have an assignee

Please fix these problems and try again.

@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Oct 29, 2024
@thoward thoward self-assigned this Oct 29, 2024
@thoward thoward closed this as completed Oct 29, 2024
@thoward thoward added grooming-q2y25 and removed needs-triage Needs attention from the triage team labels Oct 29, 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 docs/hackathon docs/intro Content under intro to Pulumi -- architecture & concepts, use cases, etc. grooming-q2y25 kind/enhancement Improvements or new features resolution/fixed This issue was fixed
Projects
Status: 🏁 Done
Development

No branches or pull requests

6 participants