Skip to content

Conversation

@gpene
Copy link
Contributor

@gpene gpene commented Jul 4, 2022

What does it do?

Restructures the existing content + inline with other plugin docs given new template / providers docs being added.

Why is it needed?

  • Adding consistency to plugin docs
  • updating for v4

Related issue(s)/PR(s)

#926 (comment)

Still needed

  • update and validate examples with v4

@gpene gpene self-assigned this Jul 4, 2022
@vercel
Copy link

vercel bot commented Jul 4, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
documentation ✅ Ready (Inspect) Visit Preview Jul 11, 2022 at 10:33AM (UTC)

@pwizla pwizla added the internal PRs created by the Strapi core team label Jul 4, 2022
</div>

## Upload files
## Examples
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would review that whole "Examples" section to be honest. I don't think the content is just examples, all those configuration options for files imported via the Media Library should be integrated/explained properly in the Upload plugin documentation. Happy to discuss that with you!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same. Happy to join the discussion if you need me 🤗

canonicalUrl: https://docs.strapi.io/developer-docs/latest/plugins/upload.html
---

# Upload
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open question: should we mention in the TOC something like "Upload (Media Library)"? Just to make sure that when users scroll down the TOC to look for a Media Library documentation, they know that this is the right file? 🤔

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a good idea to me :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But this isn't Media Library documentation - where that is a component of the admin panel it is properly documented in the User Guide, which is where users would/should look for such content. If they are in the Developer docs, the naming should reflect what exists in code, hence upload plugin.

Copy link
Collaborator

@pwizla pwizla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Gabriel for the work. I've added some minor comments and questions. And I also think the Examples section needs to be revised. Happy to discuss it if needed :)

</div>

## Upload files
## Examples
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same. Happy to join the discussion if you need me 🤗

canonicalUrl: https://docs.strapi.io/developer-docs/latest/plugins/upload.html
---

# Upload
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a good idea to me :)

@gpene gpene changed the title [WIP] Update Upload Plugin docs Update Upload Plugin docs Jul 11, 2022
@gpene gpene marked this pull request as ready for review July 11, 2022 10:41
@pwizla pwizla added this to the 4.2.3 milestone Jul 13, 2022
@pwizla
Copy link
Collaborator

pwizla commented Jul 13, 2022

As discussed with you, closed in favor of #992, thank you, guys!

@pwizla pwizla closed this Jul 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants