Update installation documentation for Symfony Flex #1006

kunicmarko20 · 2018-01-24T21:11:08Z

I am targeting this branch, because I am updating documentation for 4.x

Subject

I did a fresh install of SonataUser and docs weren't really ready for use with the new structure of Symfony Flex. Basically, with current documentation, someone that has never used Sonata packages would have a problem getting SonataUser working.

kunicmarko20 · 2018-01-24T21:28:08Z

There are some problems I encountered while installing and I need your suggestion on how to proceed and should this be added to docs:

1. When installing SonataAdmin there is an error:

The service "sonata.admin.block.admin_list" has a dependency on a non-existent service "templating".

Solution is:

framework:
    templating:
        engines: ['twig']

As there are PRs on all bundles and Sonata is moving away from templating, I am not sure if this should be added?

2. When installing SonataUser there is an error:

friendsofsymfony/user-bundle v2.0.2 requires symfony/form ^2.7 || ^3.0

There still is no release of FOSUserBundle.

Solution:

composer require friendsofsymfony/user-bundle:2.1.x-dev

3. After installing FOSUser like I did in 2. because there is no recipe the bundle is added to bundles.php but cache clear after the installation throws an error because there is no configuration for FOSUser:

In ArrayNode.php line 238:
                                                                     
The child node "db_driver" at path "fos_user" must be configured.

Solution:

Add configuration for FOSUser, I mean we know what to do and error is clear, but I am thinking about people that are installing this, this is connected to 2. with recipe in contrib repo this goes away.

4. The last error I encountered was this issue #942 (comment) and that comment is the solution by @jordisala1991

Did not get into details so not sure about that one at all I just added that config and it worked.

Next things are not issues but questions:

Do we still need the mention all the bundles in Enable the bundle part or just sonata-user?

php composer require sonata-project/user-bundle --no-update
php composer require sonata-project/doctrine-orm-admin-bundle  --no-update # optional
php composer require friendsofsymfony/rest-bundle  --no-update # optional when using api
php composer require nelmio/api-doc-bundle  --no-update # optional when using api
php composer require sonata-project/google-authenticator --no-update  # optional
php composer update

sonata-project/doctrine-orm-admin-bundle this one will probably already be installed as you have to follow sonata admin installation first.

Should I add Sonata block configuration to part 2.3 and move

sonata_block:
    blocks:
        #...
        sonata.user.block.menu:    # used to display the menu in profile pages
        sonata.user.block.account: # used to display menu option (login option)
        sonata.block.service.text: # used to if you plan to use Sonata user routes

from the ACL configuration to that new part?

This is it, for now, will wait for your feedback and hopefully this gets merged soon so people can install it without problems.

greg0ire · 2018-01-24T21:44:13Z

@covex-nn please answer 1.

greg0ire · 2018-01-24T21:45:49Z

docs/reference/installation.rst

+
+ACL Configuration
+~~~~~~~~~~~~~~~~~
+When using ACL, the ``UserBundle`` can prevent `normal` user to change


greg0ire · 2018-01-24T21:46:31Z

docs/reference/installation.rst

+ACL Configuration
+~~~~~~~~~~~~~~~~~
+When using ACL, the ``UserBundle`` can prevent `normal` user to change
+settings of `super-admin` users, to enable this add to the configuration:


"use the following configuration"

greg0ire

Great job!

core23 · 2018-01-25T04:47:18Z

docs/reference/installation.rst

-    php composer.phar require nelmio/api-doc-bundle  --no-update # optional when using api
-    php composer.phar require sonata-project/google-authenticator --no-update  # optional
-    php composer.phar update
+    php composer require sonata-project/user-bundle --no-update


You could remove php as well

covex-nn · 2018-01-25T05:35:51Z

The service "sonata.admin.block.admin_list" has a dependency on a non-existent service "templating".

@kunicmarko20 this error will go away if sonata-project/SonataDoctrineORMAdminBundle#794, sonata-project/SonataAdminBundle#4897 and #1000 will be released (newest BlockBundle already does not use templating service). Then a recipe for sonata-project/admin-bundle must be created and aproved. See symfony/recipes-contrib#264 (it is almost ready).

With a recipe AdminBundle could be installed and configured by this commands:

composer create-project symfony/skeleton .
composer config extra.symfony.allow-contrib true
composer require sonata-project/doctrine-orm-admin-bundle

Also, for sonata-project/doctrine-phpcr-admin-bundle sonata-project/SonataDoctrinePhpcrAdminBundle#517 must be released.

covex-nn · 2018-01-25T05:59:08Z

Also with FriendsOfSymfony/FOSUserBundle#2708 and FriendsOfSymfony/FOSUserBundle#2707 it will be possible to create a recipe for FOSUserBundle

kunicmarko20 · 2018-01-25T11:18:23Z

Thank you for info @covex-nn. So I won't add 1., 2. and 3. to docs. The only issue that is left is number 4. and my question about Enable the bundle part and sonata block config.

covex-nn · 2018-01-25T12:48:26Z

@kunicmarko20 i'm waiting for a PRs reviews in FOSUserBundle already 15 days =) and may be we will wait a month (or even more) for a 2.1.0 release. So, may be a few words about FOSUserBundle configuration would be fine.

Anyway here is how FOSUserBundle could be configured in the future with Flex FriendsOfSymfony/FOSUserBundle#2704 (comment). The main part is:

fos_user:
    service:
        mailer: fos_user.mailer.twig_swift

This parameter will not require templating service.

jordisala1991 · 2018-01-25T15:46:05Z

docs/reference/installation.rst

@@ -7,7 +7,8 @@ Installation
 Prerequisites
 -------------

-PHP 7 and Symfony 2.8 or 3 are needed to make this bundle work; there are also some Sonata dependencies that need to be installed and configured beforehand:
+PHP 7 and Symfony 2.8 or 3 are needed to make this bundle work, there are


7.1. Symfony 2.8, >=3.2 or 4 right?

3.2 support is ending next week, should I mark it as 3.3 instead?

jordisala1991 · 2018-01-25T15:46:39Z

docs/reference/installation.rst


-Next, be sure to enable the bundles in your and ``AppKernel.php`` file:
+Next, be sure to enable the bundles in your ``bundles.php`` file if they


shouldn't we explain for sf 3 and sf 4?

on Sf 2/3 it should be AppKernel

As flex is now the default way of creating new projects I though that should only be documented or am I wrong? @greg0ire I remember we talked about this on slack WDYT?

We MUST assume everyone is using sf 4 and flex. We CAN add sf 2/3 instructions.

That means I would need to add a note or something like but if you are using symfony 3, do it this way? so SHOULD I?

It's really up to you. Personally, I think people that don't know how to register a bundle and also don't start with sf 4 might be quite rare, so it's probably not needed.

I agree with that because current Symfony doc points to 4.0 and if you are using 3.4 you probably went with flex, if not then you know what you are doing. I do not mind adding docs for 3. If rest of the people think it should be added.

kunicmarko20 · 2018-01-26T19:28:10Z

I added docs for non-flex but I do not really like all the notes with If you are not using Symfony Flex, what do you think?

kunicmarko20 · 2018-01-26T19:40:56Z

docs/reference/installation.rst

+        Sonata\CoreBundle\SonataCoreBundle::class => ['all' => true],
+        Sonata\BlockBundle\SonataBlockBundle::class => ['all' => true],
+        Sonata\EasyExtendsBundle\SonataEasyExtendsBundle::class => ['all' => true],
+        FOS\UserBundle\FOSUserBundl::class => ['all' => true],


kunicmarko20 · 2018-01-28T17:12:34Z

docs/reference/installation.rst


-If you specify no parameter, the files are generated in ``app/Application/SonataUserBundle`` but you can specify the path with ``--dest=src``
+With provided parameters, the files are generated in ``src/Application/SonataUserBundle``.


This is wrong, it should be src/Application/Sonata/UserBundle

jordisala1991 · 2018-01-29T07:01:17Z

docs/reference/installation.rst

-            new Sonata\UserBundle\SonataUserBundle(),
-            // ...
-        );
+         return array(


Why did you add an extra space?

Didn't see it, will be fixed.

and you can use short array syntax here, too

OskarStark · 2018-01-29T15:12:16Z

docs/reference/installation.rst

+            #...
+            sonata.user.block.menu:    # used to display the menu in profile pages
+            sonata.user.block.account: # used to display menu option (login option)
+            sonata.block.service.text: # used to if you plan to use Sonata user routes


the comment looks strange

Yep, that block is not connected to user bundle at all, also all the other blocks are removed in 4.x (not sure if intentionally /cc @jordisala1991 ), I think I will just remove this section.

greg0ire · 2018-01-29T20:51:42Z

Thanks @kunicmarko20 !

greg0ire added the docs label Jan 24, 2018

greg0ire reviewed Jan 24, 2018

View reviewed changes

core23 requested changes Jan 25, 2018

View reviewed changes

jordisala1991 reviewed Jan 25, 2018

View reviewed changes

kunicmarko20 force-pushed the update_docs_for_flex branch from 002d043 to a374dcf Compare January 25, 2018 20:29

kunicmarko20 force-pushed the update_docs_for_flex branch from 271cf38 to fdf4f90 Compare January 26, 2018 19:29

kunicmarko20 commented Jan 26, 2018

View reviewed changes

kunicmarko20 force-pushed the update_docs_for_flex branch from fdf4f90 to 379b0f6 Compare January 28, 2018 15:57

kunicmarko20 commented Jan 28, 2018

View reviewed changes

kunicmarko20 force-pushed the update_docs_for_flex branch from 379b0f6 to 6477e8c Compare January 28, 2018 17:24

jordisala1991 reviewed Jan 29, 2018

View reviewed changes

OskarStark reviewed Jan 29, 2018

View reviewed changes

update docs for symfony flex

2d5360f

kunicmarko20 force-pushed the update_docs_for_flex branch from 6477e8c to 2d5360f Compare January 29, 2018 19:15

core23 approved these changes Jan 29, 2018

View reviewed changes

jordisala1991 approved these changes Jan 29, 2018

View reviewed changes

jordisala1991 requested review from greg0ire and OskarStark January 29, 2018 20:44

greg0ire merged commit f9a56fe into sonata-project:4.x Jan 29, 2018

kunicmarko20 deleted the update_docs_for_flex branch January 29, 2018 20:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update installation documentation for Symfony Flex #1006

Update installation documentation for Symfony Flex #1006

kunicmarko20 commented Jan 24, 2018 •

edited

Loading

kunicmarko20 commented Jan 24, 2018

greg0ire commented Jan 24, 2018

greg0ire Jan 24, 2018

greg0ire Jan 24, 2018

greg0ire left a comment

core23 Jan 25, 2018

covex-nn commented Jan 25, 2018 •

edited

Loading

covex-nn commented Jan 25, 2018

kunicmarko20 commented Jan 25, 2018

covex-nn commented Jan 25, 2018 •

edited

Loading

jordisala1991 Jan 25, 2018

kunicmarko20 Jan 25, 2018

jordisala1991 Jan 25, 2018

kunicmarko20 Jan 25, 2018

greg0ire Jan 25, 2018

kunicmarko20 Jan 25, 2018

greg0ire Jan 25, 2018

kunicmarko20 Jan 25, 2018

kunicmarko20 commented Jan 26, 2018

kunicmarko20 Jan 26, 2018

kunicmarko20 Jan 28, 2018

jordisala1991 Jan 29, 2018

kunicmarko20 Jan 29, 2018

OskarStark Jan 29, 2018

OskarStark Jan 29, 2018

kunicmarko20 Jan 29, 2018

greg0ire commented Jan 29, 2018


		Next, be sure to enable the bundles in your and ``AppKernel.php`` file:
		Next, be sure to enable the bundles in your ``bundles.php`` file if they


		If you specify no parameter, the files are generated in ``app/Application/SonataUserBundle`` but you can specify the path with ``--dest=src``
		With provided parameters, the files are generated in ``src/Application/SonataUserBundle``.

Update installation documentation for Symfony Flex #1006

Update installation documentation for Symfony Flex #1006

Conversation

kunicmarko20 commented Jan 24, 2018 • edited Loading

Subject

kunicmarko20 commented Jan 24, 2018

greg0ire commented Jan 24, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg0ire left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

covex-nn commented Jan 25, 2018 • edited Loading

covex-nn commented Jan 25, 2018

kunicmarko20 commented Jan 25, 2018

covex-nn commented Jan 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kunicmarko20 commented Jan 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg0ire commented Jan 29, 2018

kunicmarko20 commented Jan 24, 2018 •

edited

Loading

covex-nn commented Jan 25, 2018 •

edited

Loading

covex-nn commented Jan 25, 2018 •

edited

Loading