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

[Meta issue] Upload plugin #1948

Open
3 tasks
pwizla opened this issue Dec 11, 2023 · 8 comments
Open
3 tasks

[Meta issue] Upload plugin #1948

pwizla opened this issue Dec 11, 2023 · 8 comments
Assignees
Labels
issue: docs/code example Issues about incorrect code examples found on docs.strapi.io issue: docs/instructions Issues about incorrect instructions found on docs.strapi.io

Comments

@pwizla
Copy link
Collaborator

pwizla commented Dec 11, 2023

Link to the documentation page or resource

https://docs.strapi.io/dev-docs/plugins/upload

Describe the bug

Hi,
I'm Pierre, Lead Technical Writer at Strapi.

We noticed users have reported several errors or outdated instructions about the Upload plugin.

I will group these issues here on a single "meta" page. We are currently heavily focused on documenting v5, the upcoming v4 features, and Strapi Cloud, but updating the Upload plugin documentation is in our backlog (and the page will most probably be updated during v5 development to match the new data formats).


Issues reported by users:

In the meantime, if would like to create a documentation PR to update the Upload documentation and fix any of the aforementioned issues, we'd be super happy to review it 🤗

@pwizla pwizla self-assigned this Dec 11, 2023
@pwizla pwizla added issue: docs/instructions Issues about incorrect instructions found on docs.strapi.io issue: docs/code example Issues about incorrect code examples found on docs.strapi.io labels Dec 11, 2023
@d717an
Copy link

d717an commented Mar 27, 2024

Hi, I'm not sure if this is the correct spot to report this, but the documentation of the S3 Upload Plugin is out of date.

The doc described here, https://docs.strapi.io/dev-docs/plugins/upload, links to this S3 plugin page, but I'm not sure where to post this as an issue since the strapi monorepo points to this documentation repo for doc updates.

Long story short, the S3 plugin page's Configuration erroneously points to AWS SDK v2 docs, not the new v3 documentation. This led to a lot of frustration for my team as we tried to configure the plugin to work with our company's forward proxy.

Here are the v3 AWS SDK Docs for S3: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/#s3clientconfig

@pwizla
Copy link
Collaborator Author

pwizla commented Mar 27, 2024

Hi @d717an.
I'm sorry you're having troubles with the S3 Upload plugin.
Could you please create an issue in the strapi/strapi repo? As this is where the documentation for this package is managed, and I don't have control over this repo.
https://github.com/strapi/strapi/tree/main/packages/providers/upload-aws-s3

If you don't get any reply, I'll ping some engineers so they can have a quicker look to it.

@d717an
Copy link

d717an commented Apr 3, 2024

Thanks @pwizla, created.

No time pressure from my end on this; our issue is solved now that we know where to look. This improvement will be for other strapi users.

@SpeedAD
Copy link
Contributor

SpeedAD commented Apr 3, 2024

Hey team,

If nobody has picked this up I'd love to make my first contribution!
I have been dwelling on supporting open source, and I feel starting by contributing via documentation would be good.
Let me know! @pwizla

@pwizla
Copy link
Collaborator Author

pwizla commented Apr 3, 2024

Thanks, @d717an!
If no engineer takes care of your issue feel free to ping me and I'll create a PR myself in this other repo so it does not get stuck for too long (and I'll try to push them for a quick review 😄 🏃)

@pwizla
Copy link
Collaborator Author

pwizla commented Apr 3, 2024

Hi @SpeedAD and thank you for your enthusiasm and willingness to help!
I am not sure what you would like to work on, though 🤔 What did you have in mind? 🙂

(Edit: if you were looking for an easy, first time contribution, you can create a pull request to fix the following issue: #2056 )

@SpeedAD
Copy link
Contributor

SpeedAD commented Apr 3, 2024

@pwizla Well I landed here after i saw #20003 on the main strapi/strapi repository. So i thought I can help by rectifying the link on the documentation

(Edit: Thanks for mentioning the easy one for me :) Planning to fork the documentation repo now)

@pwizla
Copy link
Collaborator Author

pwizla commented Apr 3, 2024

Oh, I see @SpeedAD! So you can probably create a PR for #20003 on the strapi/strapi repo.
I won't review it because I only maintain the strapi/documentation repository, but if in the future you need any help about creating PRs for strapi/documentation please just let me know 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue: docs/code example Issues about incorrect code examples found on docs.strapi.io issue: docs/instructions Issues about incorrect instructions found on docs.strapi.io
Projects
None yet
Development

No branches or pull requests

3 participants