doctrine-extensions / DoctrineExtensions

Doctrine2 behavioral extensions, Translatable, Sluggable, Tree-NestedSet, Timestampable, Loggable, Sortable
MIT License
4.04k stars 1.27k forks source link

improvement of the documentation #2431

Closed devozanges closed 1 year ago

devozanges commented 2 years ago

Hello, it would be great to have this kind of information in priority in the doc because often, we are obliged to go and look in stackoverflow for this kind of information essential to the good functioning of the extension we want to use.

image Thanks for your great work

franmomu commented 2 years ago

thanks @devozanges, but that documentation is for the bundle https://github.com/stof/StofDoctrineExtensionsBundle, not this library.

By the way, maybe the bundle could be moved to doctrine-extensions? to ease the maintenance if @stof and @AkenRoberts agree 🤔

AkenRoberts commented 2 years ago

I've pinged Christophe about that a couple times with no response. Definitely support moving it here if he does.

seyfcom commented 2 years ago

The documentation is really missing parts for non-super-specialist !!

I'm testing translatable and I see nowhere that I need to update doctrine.yaml and without a bunch of lines, nothing is working !

I had to add the last part

mappings: App: is_bundle: false dir: '%kernel.project_dir%/src/Entity' prefix: 'App\Entity' alias: App translatable: type: annotation is_bundle: false prefix: Gedmo\Translatable\Entity dir: '%kernel.project_dir%/vendor/gedmo/doctrine-extensions/src/Translatable/Entity' alias: GedmoTranslatable

php 8.1 symf6.1

franmomu commented 2 years ago

The documentation is really missing parts for non-super-specialist !!

I'm testing translatable and I see nowhere that I need to update doctrine.yaml and without a bunch of lines, nothing is working !

I had to add the last part

mappings: App: is_bundle: false dir: '%kernel.project_dir%/src/Entity' prefix: 'App\Entity' alias: App translatable: type: annotation is_bundle: false prefix: Gedmo\Translatable\Entity dir: '%kernel.project_dir%/vendor/gedmo/doctrine-extensions/src/Translatable/Entity' alias: GedmoTranslatable

php 8.1 symf6.1

Yeah any PR to improve the documentation is very welcome! by the way you can find that documentation in https://github.com/doctrine-extensions/DoctrineExtensions/blob/af2f05212300fc275cd7fa59f3040567dbffd72d/doc/symfony4.md#mapping, in this case I guess we should remove the "Symfony 4" part and replace it with "Symfony >= 4.4"

seyfcom commented 2 years ago

Anyway thanks to all the people having done those extensions !!

I missed that file ! sorry !

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.