symfony-docs icon indicating copy to clipboard operation
symfony-docs copied to clipboard

Rework the file upload docs

Open javiereguiluz opened this issue 9 months ago • 4 comments

We've merged #19807 and now the /controller page shows the nice #[MapUploadedFile] attribute.

This new feature is fantastic ... but I wonder if it's a good idea to show it in /controller.

This is one of the most critical chapters of Symfony Docs and part of the "Getting Started" series. So, I think that showing this could be a bit overwhelming for readers, mostly newcomers.

Also, we have this page too, which now looks weird and outdated: https://symfony.com/doc/current/controller/upload_file.html


So, this is what I propose:

  • Update controller/upload_file.rst entirely:
    • Show the #[MapUploadedFile] attribute first
    • Think if we should still show the previous way. If yes, let's do it at the bottom of the article and more concisely
  • Remove the #[MapUploadedFile] docs from controller.rst and only keep a tip mentioning it and linking to the doc about file uploads
  • These changes should only be made on 7.1 branch

What do you think?

javiereguiluz avatar May 08 '24 11:05 javiereguiluz

Do you mind if I give a try on it ?

MrYamous avatar Jul 02 '24 17:07 MrYamous

That would be awesome. But, before doing the actual work, an you please outline very briefly the changes you inten to make so others can help review the plan before doing the work? Thanks!

javiereguiluz avatar Jul 02 '24 17:07 javiereguiluz

I thought about making the changes you described in the issue

MrYamous avatar Jul 07 '24 04:07 MrYamous

@MrYamous I'm sorry for not having replied to you 🙏 OK, if you can, please try to contribute these changes. Thank you.

javiereguiluz avatar Jul 23 '24 07:07 javiereguiluz