Update documentation

[jordisala1991]

Documentation Request

For the 4.0 release, we should update the docs to reflect recent changes on Sonata.

[jordisala1991]

One thing that we could do is to remove the php and symfony versions from the docs. wdyt @sonata-project/contributors ? I think this should be the same for all sonata bundles. The problem with having the versions on the docs is that it becomes outdated and does not reflect what is supported, but on the other hand it is nice reading the docs and figuring out what versions are supported right away.

[VincentLanglet]

One thing that we could do is to remove the php and symfony versions from the docs. wdyt @sonata-project/contributors ? I think this should be the same for all sonata bundles. The problem with having the versions on the docs is that it becomes outdated and does not reflect what is supported, but on the other hand it is nice reading the docs and figuring out what versions are supported right away.

I think it's indeed a good idea to remove it and let people rely on the composer.json

[jordisala1991]

@eerison said:

link: https://docs.sonata-project.org/projects/SonataMediaBundle/en/3.x/reference/creating_a_provider_class/#register-the-class-with-the-service-container don't need this

• '@sonata.media.http.client'
• '@sonata.media.metadata.proxy'

[wbloszyk]

@eerison said:

link: https://docs.sonata-project.org/projects/SonataMediaBundle/en/3.x/reference/creating_a_provider_class/#register-the-class-with-the-service-container don't need this

• '@sonata.media.http.client'
• '@sonata.media.metadata.proxy'

If I remember correctly http.client is required for some provider like YouTubeProvider, but not require for local FileProvider. Mybe nice idea will be make it optional? Also in docs.

[eerison]

Hey guys I guess I was wrong, the provider in the exemple (VimeoProvider) there are those dependencies as optional, but if it's optional, in the doc should say what happen if you don't put this.

 ?MetadataBuilderInterface $metadata = null,
 ?RequestFactoryInterface $requestFactory = null 

Other thing:

what do you think to add the others providers in the documentation? maybe just the list should be fine. because I don't see which providers exist into Sonata, I need to check in the code to see.

[VincentLanglet]

Hey guys I guess I was wrong, the provider in the exemple (VimeoProvider) there are those dependencies as optional, but if it's optional, in the doc should say what happen if you don't put this.

 ?MetadataBuilderInterface $metadata = null,
 ?RequestFactoryInterface $requestFactory = null 

Other thing:

what do you think to add the others providers in the documentation? maybe just the list should be fine. because I don't see which providers exist into Sonata, I need to check in the code to see.

I would say adding documentation is always a good thing. If you got some trouble, another one could too. So if you want to provide a PR, go for it :)