Skip to content

Rework the file upload docs #19872

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

Open
javiereguiluz opened this issue May 8, 2024 · 4 comments
Open

Rework the file upload docs #19872

javiereguiluz opened this issue May 8, 2024 · 4 comments
Labels
help wanted Issues and PRs which are looking for volunteers to complete them. Waiting team decision Request for comments from Symfony Docs Team members
Milestone

Comments

@javiereguiluz
Copy link
Member

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 javiereguiluz added help wanted Issues and PRs which are looking for volunteers to complete them. Waiting team decision Request for comments from Symfony Docs Team members labels May 8, 2024
@javiereguiluz javiereguiluz added this to the 7.1 milestone May 8, 2024
@MrYamous
Copy link
Contributor

MrYamous commented Jul 2, 2024

Do you mind if I give a try on it ?

@javiereguiluz
Copy link
Member Author

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!

@MrYamous
Copy link
Contributor

MrYamous commented Jul 7, 2024

I thought about making the changes you described in the issue

@javiereguiluz
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issues and PRs which are looking for volunteers to complete them. Waiting team decision Request for comments from Symfony Docs Team members
Projects
None yet
Development

No branches or pull requests

2 participants