Repository navigation
Add S3 hosting guidance for Blueprint resources - #3754
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds documentation explaining how to host Blueprint-related URL resources on Amazon S3 so Playground can fetch them successfully.
Changes:
- Documented S3 object URL usage for
urlresources - Added example public-read bucket policy and CORS configuration for
playground.wordpress.net - Added Blueprint examples for
installPluginwithpluginDataand?blueprint-url=pointing to S3
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
I’ve pushed a follow-up that tightens the S3 guidance based on review feedback. It now scopes the public bucket policy to Blueprint/plugin/theme prefixes, adds a Block Public Access note, documents the dotted-bucket HTTPS concern with an AWS reference, and includes a concrete |
|
Looping in @fellyph |
|
@fellyph following up on Adam's ping above, this is still ready for review whenever you get a chance, the target file has not changed since. |
|
Two non-blocking suggestions to clarify the S3 guidance:
The current recommendations otherwise look sound. The plugin Blueprint and theme step validate against both the published Blueprint schema and the repository validator. This verification did not include provisioning an S3 bucket or an end-to-end S3 installation. |
Name the two Block Public Access settings that must be off for the public read policy (BlockPublicPolicy, RestrictPublicBuckets), note that the ACL settings can stay on and that account or organization settings still apply, and say that AllowedOrigins only limits browser reads, with self-hosted Playground origins added there.
|
Thanks @fellyph, both suggestions are in 874d5bc:
I checked the wording against the AWS pages you linked; like your review, this did not include provisioning a bucket. |
|
No actionable comments were generated in the recent review.
|
| Layer / File(s) | Summary |
|---|---|
S3 URLs and access configuration packages/docs/site/docs/blueprints/04-resources.md |
Documents virtual-hosted and path-style S3 URLs, public-read bucket policy requirements, Block Public Access settings, and CORS configuration. |
Loading hosted resources packages/docs/site/docs/blueprints/04-resources.md |
Shows how to install a plugin or theme ZIP through a url resource and load a Blueprint JSON file with ?blueprint-url=. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Merge Risk: 
Minimal · up to 874d5
-
No concrete current-head defect remains in the reviewed documentation changes.
Pre-merge checks: 
5
-
Full details: Linked Issues check
-
Explanation
Issue
#962requires S3 guidance for Blueprint, plugin, and theme resources. The changed documentation provides regional object URL formats, bucket and region substitutions, a scoped public-read policy, Block Public Access guidance, CORS settings, aninstallPluginexample withpluginData, aninstallThemeexample withthemeData, and a?blueprint-url=example. It also links AWS settings documentation and explains public access and self-hosted Playground origins.
Full details: Out of Scope Changes check
-
Explanation
The reviewed change is limited to
packages/docs/site/docs/blueprints/04-resources.md. The added URL, policy, CORS, security, plugin, theme, and Blueprint examples directly support issue#962. No unrelated change is shown.
Full details: Docstring Coverage
-
Explanation
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
|
@fellyph, can you please remove me as a reviewer on this PR? Much appreciated |
|
@zaerl Sure, I will check other PRs that you are tagged in. |
What this changes
Adds Amazon S3 hosting guidance for Blueprint URL resources, including:
installPluginBlueprint example usingpluginData?blueprint-url=example for S3-hosted Blueprint filesRelated issue
Fixes #962
Summary by CodeRabbit