Update aws.s3.Bucket notes to point to aws.s3.BucketV2 #4491
Conversation
Does the PR have any schema changes?Looking good! No breaking changes found. Maintainer note: consult the runbook for dealing with any breaking changes. |
t0yv0
force-pushed
the
t0yv0/update-aws-bucket-notes
branch
from
d6b834e to
fcb1301
Compare
|
The registry PR has published. |
| @@ -135584,28 +135584,28 @@ | |||
| "items": { | |||
| "type": "string" | |||
| }, | |||
| "description": "List of headers allowed.\n" | |||
| "description": "Specifies which headers are allowed.\n" | |||
There was a problem hiding this comment.
Where do those changes come from? I don't see those descriptions being modified in the PR
There was a problem hiding this comment.
Fix an issue with documentation override: due to a bug docs/resource/aws_s3_bucket_legacy.md was not being picked up and the aws.s3.Bucket page was incorrectly serving docs for the aws.s3.BucketV2 resource. This is fixed here.
There was a problem hiding this comment.
There was a bug that sent BucketV2 documentation into the Bucket page, ignoring the handcrafted aws_s3_bucket_legacy.md file
There was a problem hiding this comment.
Ah, ok that makes sense!
| @@ -3756,7 +3756,7 @@ compatibility shim in favor of the new "name" field.`) | |||
| Transform: tfbridge.TransformJSONDocument, | |||
| }, | |||
| }, | |||
| Docs: &tfbridge.DocInfo{Source: "../../../../docs/resource/aws_s3_bucket_legacy.md"}, | |||
| Docs: &tfbridge.DocInfo{Markdown: maybeReadFile("docs/resource/aws_s3_bucket_legacy.md")}, | |||
There was a problem hiding this comment.
Fix to the silently ignored source here.
|
This PR has been shipped in release v6.56.1. |
Add a note for the aws.s3.Bucket page to direct users to aws.s3.BucketV2.
Fixes https://github.com/pulumi/home/issues/3629
Fix an issue with documentation override: due to a bug
docs/resource/aws_s3_bucket_legacy.mdwas not being picked up and theaws.s3.Bucketpage was incorrectly serving docs for theaws.s3.BucketV2resource. This is fixed here.This PR should not merge until pulumi/registry#5444 gets published.