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 documentation to better explain the impact of changing the synced folder name #45

Open
scottslowe opened this issue Jul 31, 2023 · 0 comments
Assignees
Labels
impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features size/S Estimated effort to complete (1-2 days).

Comments

@scottslowe
Copy link
Contributor

When the synced-folder component is used to create a synced folder, a resource name is supplied, as in this TypeScript example:

const folder = new synced.S3BucketFolder("synced-folder", {
        path: "./testdata",
        bucketName: "somebucketname",
        acl: aws.s3.BucketOwnerFullControlAcl,
        managedObjects: false
    });

If this resource name is changed (say, from synced-folder to synced-s3-folder), this results in the creation of an entirely new resource. As a result, Pulumi will remove the old resource. This behavior is by design, but perhaps may be unexpected to some users. To help address this, we should update the documentation for this component to properly explain this behavior.

This update should include changes to both the documentation in this repository as well as the Pulumi Registry.

@scottslowe scottslowe added impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features size/S Estimated effort to complete (1-2 days). labels Jul 31, 2023
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Jul 31, 2023
@scottslowe scottslowe removed the needs-triage Needs attention from the triage team label Jul 31, 2023
@cnunciato cnunciato added this to the 0.93 milestone Aug 12, 2023
@cnunciato cnunciato self-assigned this Aug 12, 2023
@cnunciato cnunciato modified the milestones: 0.93, 0.94 Sep 6, 2023
@cnunciato cnunciato modified the milestones: 0.94, 0.95 Sep 28, 2023
@mikhailshilkov mikhailshilkov removed this from the 0.95 milestone Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features size/S Estimated effort to complete (1-2 days).
Projects
None yet
Development

No branches or pull requests

3 participants