You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is part of the DX initiative. I think the current documentation has a lot of information, but isn't organized as well as it can be, especially for someone who is using the bundle for the first time. It's especially tricky because we don't want to repeat docs that are in the main library, but I think we can make some small changes that will help a lot.
Here is a potential first experience with this bundle
The composer.json require key is actually pretty good. But (and I'm not sure about this), telling the user to use composer requiremight be even better. Often, I see people copy and paste the entire require block. I think the php and symfony/symfony lines might also confuse them.
Overall, after installation, I think we should have a little table-of-contents called "Using each Extension", with a bulleted list of each extension that links to a separate file for docs about using just that extension. In each file, we'd tell them exactly how their configuration needs to look (e.g. enabling the listener, adding a filter (for softdeleteable), etc) and how to use that extension. We would of course have links to the real library for all the "heavy lifting".
Comments warmly welcome!
Thanks!
The text was updated successfully, but these errors were encountered:
Hi there!
This is part of the DX initiative. I think the current documentation has a lot of information, but isn't organized as well as it can be, especially for someone who is using the bundle for the first time. It's especially tricky because we don't want to repeat docs that are in the main library, but I think we can make some small changes that will help a lot.
Here is a potential first experience with this bundle
composer.json
require key is actually pretty good. But (and I'm not sure about this), telling the user to usecomposer require
might be even better. Often, I see people copy and paste the entirerequire
block. I think thephp
andsymfony/symfony
lines might also confuse them.AppKernel
, the next thing I see is: https://github.com/stof/StofDoctrineExtensionsBundle/blob/master/Resources/doc/index.rst#add-the-extensions-to-your-mapping. This is not actually needed unless you're using one of these parts of the bundle (e.g. Translatable, Loggable). I think these should live individually under sections for each extension. The same is true for theEnable the softdeleteable filter
header.Overall, after installation, I think we should have a little table-of-contents called "Using each Extension", with a bulleted list of each extension that links to a separate file for docs about using just that extension. In each file, we'd tell them exactly how their configuration needs to look (e.g. enabling the listener, adding a filter (for softdeleteable), etc) and how to use that extension. We would of course have links to the real library for all the "heavy lifting".
Comments warmly welcome!
Thanks!
The text was updated successfully, but these errors were encountered: