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

custom_resources: Broken source code links in "Provider Framework Examples" section #29676

Closed
glacius-mitchell opened this issue Apr 1, 2024 · 4 comments
Assignees
Labels
@aws-cdk/custom-resources Related to AWS CDK Custom Resources documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@glacius-mitchell
Copy link

Describe the issue

The source code links in the Provider Framework Examples section are broken:

S3File
Provisions an object in an S3 bucket with textual contents. See the source code for the construct and handler.

S3Assert
Checks that the textual contents of an S3 object matches a certain value. The check will be retried for 5 minutes as long as the object is not found or the value is different. See the source code for the construct and handler.

In particular, they all point to files under https:/aws/aws-cdk/tree/main/packages/aws-cdk-lib/custom-resources/test/provider-framework/integration-test-fixtures/, which no longer exists.

That directory has been relocated to https:/aws/aws-cdk/tree/main/packages/%40aws-cdk-testing/framework-integ/test/custom-resources/test/provider-framework/integration-test-fixtures and the links should be updated accordingly.

Current broken links:

Proposed working links:

Links

@glacius-mitchell glacius-mitchell added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Apr 1, 2024
@github-actions github-actions bot added the @aws-cdk/custom-resources Related to AWS CDK Custom Resources label Apr 1, 2024
@khushail khushail self-assigned this Apr 1, 2024
@khushail khushail added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Apr 1, 2024
@khushail
Copy link
Contributor

khushail commented Apr 1, 2024

Hi @glacius-mitchell , thanks for reaching out.

The mentioned broken links have been fixed in this PR, merged 5 days ago. It should be working soon in the next release.

@khushail khushail added p2 effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Apr 1, 2024
@khushail khushail closed this as completed Apr 1, 2024
Copy link

github-actions bot commented Apr 1, 2024

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@glacius-mitchell
Copy link
Author

Hi @glacius-mitchell , thanks for reaching out.

The mentioned broken links have been fixed in this PR, merged 5 days ago. It should be working soon in the next release.

Perfect, thanks!

@aws-cdk-automation
Copy link
Collaborator

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

@aws aws locked as resolved and limited conversation to collaborators Jul 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
@aws-cdk/custom-resources Related to AWS CDK Custom Resources documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
Development

No branches or pull requests

3 participants