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

Improve stack readme docs #12432

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve stack readme docs #12432

wants to merge 3 commits into from

Conversation

pierskarsenbarg
Copy link
Member

@pierskarsenbarg pierskarsenbarg commented Aug 2, 2024 •
edited
Loading

  • Updated stack readme docs
  • Updated stack readme example with something a bit more real world

Proposed changes

  • The readme sample now has valid values in it (can't just reference resource outputs)
  • Added a real world Pulumi program that matches what the sample readme has

Unreleased product version (optional)

Related issues (optional)

@pierskarsenbarg pierskarsenbarg marked this pull request as ready for review August 2, 2024 11:59
@pierskarsenbarg pierskarsenbarg requested a review from a team as a code owner August 2, 2024 11:59
@pulumi-bot
Copy link
Collaborator

Your site preview for commit 29432b7 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-12432-29432b74.s3-website.us-west-2.amazonaws.com.

cnunciato
cnunciato reviewed Oct 9, 2024
View reviewed changes
content/docs/pulumi-cloud/projects-and-stacks.md
export const cloudwatchLogGroup = loggroup.name;
export const instanceId = instance.id;
export const dbResourceId = instance.dbiResourceId;
export const readme = readFileSync("./Pulumi.readme.md").toString();
Copy link
Contributor

@cnunciato cnunciato Oct 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Isn't this really the only useful line for purposes of illustrating this concept (separate, perhaps, from an additional Pulumi.readme.md go along with it)? I'm not sure I understand what purpose the rest of the code in the examples serves, given the readme export doesn't seem to reference any of it. (Sorry if I'm completely misunderstanding what you're aiming for here, though.)

Copy link
Member Author

@pierskarsenbarg pierskarsenbarg Oct 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The previous version didn't actually work. This you can copy and paste.

Or at least that was my intention. Let me double check that it's still valid (this was written a while ago)

@pulumi-bot
Copy link
Collaborator

Your site preview for commit 5d7003d is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-12432-5d7003da.s3-website.us-west-2.amazonaws.com.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cnunciato cnunciato cnunciato left review comments

At least 1 approving review is required to merge this pull request.

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

Successfully merging this pull request may close these issues.
3 participants
@pierskarsenbarg @pulumi-bot @cnunciato