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

WP S3 plugin needs full package with vendor folder #9257

Merged
merged 2 commits into from
Oct 23, 2024
Merged

Conversation

jms-pantheon
Copy link
Contributor

Summary

AWS S3 Setup for WordPress - Download instructions were unclear.

@jms-pantheon jms-pantheon requested a review from a team as a code owner October 14, 2024 22:05
Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9257-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@rachelwhitton rachelwhitton added Type: Fix Content Issue or PR to resolve incorrect information in the docs Topic: WordPress WordPress-specific labels Oct 16, 2024
@rachelwhitton
Copy link
Member

assigning to @jazzsequence to consider testing with the latest version of the plugin and updating docs

@jms-pantheon
Copy link
Contributor Author

Reviewing this now, it looks like that plugin is removing the manual install. Perhaps we should just refer people to that project's readme for install instructions

@jazzsequence
Copy link
Contributor

Looking at the HM repo now, and in particular the line:

Composer's autoloader must be loaded before S3 Uploads is loaded.

I'm thinking that it's not possible to install S3 Uploads without composer. We should call that out specifically in the opening paragraph as a requirement. I also don't think that WP Offload Media requires a license (I am using it on my personal site without one), but it's required if you want the urls to match your domain (rather than the S3 bucket or DO space or whatever). So maybe we can lean heavier into using that plugin instead.

Given we just link out to WP Offload Media for docs/instruction there, I think we should probably do the same for S3 Uploads (maybe with a note that WP-CLI commands in HM's docs must be wrapped in Terminus syntax for use on a Pantheon site.

refer instead to their docs and note that you need Composer to install
@jazzsequence
Copy link
Contributor

@jms-pantheon I pushed up some changes that remove the detailed instructions for S3 Uploads in favor of just linking over to their README. I also tweaked some of the language around Offload Media and noted that S3 Uploads requires Composer. Given it's a plugin that we don't maintain, it seems like a better practice to link out to their docs rather than trying to recreate them. Lemme know what you think and we can get this merged.

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9257-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@jms-pantheon
Copy link
Contributor Author

Thanks @jazzsequence that looks like a good move

@jazzsequence
Copy link
Contributor

Merging!

@jazzsequence jazzsequence merged commit 6dfe5de into main Oct 23, 2024
12 checks passed
@jazzsequence jazzsequence deleted the s3-wp-download branch October 23, 2024 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Topic: WordPress WordPress-specific Type: Fix Content Issue or PR to resolve incorrect information in the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants