Merge branch 'master' into dev

Conflicts:
	bundles/phpcr_odm.rst
	cookbook/creating_a_cms/getting-started.rst
	cookbook/creating_a_cms/make-homepage.rst

Author: wouterj

book/static_content.rst

@@ -50,7 +50,7 @@ It also specifies the translation strategy:
         use Doctrine\ODM\PHPCR\Mapping\Annotations as PHPCR;
 
         /**
-         * @PHPCRODM\Document(translator="child", referenceable=true)
+         * @PHPCR\Document(translator="child", referenceable=true)
          */
 
 For information on the available translation strategies, refer to the Doctrine

bundles/map.rst.inc

@@ -56,7 +56,7 @@ library or they introduce a complete new concept.
 
 * :doc:`search/index`
 
-* :doc:`search/introduction`
+  * :doc:`search/introduction`
 
 * :doc:`tree_browser/index`
 

bundles/media/adapters/elfinder.rst

@@ -13,9 +13,8 @@ implementing the MediaBundle interfaces.
 Installation
 ~~~~~~~~~~~~
 
-1. *FMElfinderBundle* - Follow the installation instructions from the
-   `FMElfinderBundle documentation`_.
-2. *FMElfinderBundle* - Use the MediaBundle adapter:
+1. Install the FMElfinderBundle according to the `FMElfinderBundle documentation`_.
+2. Configure the FMElfinderBundle to use the MediaBundle adapter:
 
    .. configuration-block::
 
@@ -74,8 +73,15 @@ Installation
                ),
            ));
 
-3. *LiipImagineBundle* - When using LiipImagineBundle, add an imagine filter
-   for the thumbnails:
+.. note::
+
+    The driver service depends on your storage layer. For now, the MediaBundle
+    only provides a PHPCR driver. To make the above configuration work, you
+    need to enable PHPCR either globally on ``cmf_core.persistence:phpcr`` or,
+    if you only use the MediaBundle, directly on the bundle at
+    ``cmf_media.persistence.phpcr``.
+
+3. When using the LiipImagineBundle, add an imagine filter for the thumbnails:
 
    .. configuration-block::
 
@@ -131,7 +137,7 @@ Installation
                ),
            ));
 
-4. Test the elFinder browser by navigating to: http://localhost:8000/app_dev.php/elfinder
+4. Test the elFinder browser by navigating to: http://<yoursite>/app_dev.php/elfinder
 
 .. _`elFinder`: http://elfinder.org
 .. _`FMElfinderBundle`: https://github.com/helios-ag/FMElfinderBundle

bundles/media/introduction.rst

@@ -87,9 +87,14 @@ Installation
 
            return $collection;
 
-3. Run the ``doctrine:phpcr:repository:init`` command, it runs all tagged
-   :ref:`phpcr-odm-repository-initializers` including the MediaBundle
-   initializer.
+3. For now, the only supported persistence layer is PHPCR. If you enabled PHPCR
+   on the CoreBundle, you need to do nothing here. If you do not have the
+   CMF CoreBundle in your project, you need to configure
+   ``cmf_media.persistence.phpcr.enabled: true``.
+
+4. For PHPCR, run the ``doctrine:phpcr:repository:init`` command, to have the
+   base paths initialized, using the
+   :ref:`repository initializers <phpcr-odm-repository-initializers>`.
 
 Interfaces
 ----------

bundles/menu/sonata_admin.rst

@@ -24,14 +24,13 @@ select the menu node target.
 
         # app/config/config.yml
         cmf_menu:
-            dynamic:
-                persistence:
-                    phpcr:
-                        # use true/false to force using / not using sonata admin
-                        use_sonata_admin: auto
+            persistence:
+                phpcr:
+                    # use true/false to force using / not using sonata admin
+                    use_sonata_admin: auto
 
-                        # used with Sonata Admin to manage content; defaults to %cmf_core.basepath%/content
-                        content_basepath: ~
+                    # used with Sonata Admin to manage content; defaults to %cmf_core.basepath%/content
+                    content_basepath: ~
 
     .. code-block:: xml
 
@@ -42,33 +41,29 @@ select the menu node target.
             xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
             <config xmlns="http://cmf.symfony.com/schema/dic/menu">
-                <dynamic>
-                    <persistence>
-                        <!-- use-sonata-admin: use true/false to force using / not using sonata admin -->
-                        <!-- content-basepath: used with Sonata Admin to manage content;
-                                               defaults to %cmf_core.basepath%/content -->
-                        <phpcr
-                            use-sonata-admin="auto"
-                            content-basepath="null"
-                        />
-                    </persistence>
-                </dynamic>
+                <persistence>
+                    <!-- use-sonata-admin: use true/false to force using / not using sonata admin -->
+                    <!-- content-basepath: used with Sonata Admin to manage content;
+                                           defaults to %cmf_core.basepath%/content -->
+                    <phpcr
+                        use-sonata-admin="auto"
+                        content-basepath="null"
+                    />
+                </persistence>
             </config>
         </container>
 
     .. code-block:: php
 
         // app/config/config.php
         $container->loadFromExtension('cmf_menu', array(
-            'dynamic' => array(
-                'persistence' => array(
-                    'phpcr' => array(
-                        // use true/false to force using / not using sonata admin
-                        'use_sonata_admin' => 'auto',
-
-                        // used with Sonata Admin to manage content; defaults to %cmf_core.basepath%/content
-                        'content_basepath' => null,
-                    ),
+            'persistence' => array(
+                'phpcr' => array(
+                    // use true/false to force using / not using sonata admin
+                    'use_sonata_admin' => 'auto',
+
+                    // used with Sonata Admin to manage content; defaults to %cmf_core.basepath%/content
+                    'content_basepath' => null,
                 ),
             ),
         ));

bundles/phpcr_odm.rst

@@ -1244,6 +1244,11 @@ Form Types
 The bundle provides a couple of handy form types for PHPCR and PHPCR-ODM
 specific cases, along with form type guessers.
 
+.. tip::
+
+    When editing associative multivalue fields, have a look at the
+    `BurgovKeyValueFormBundle`_.
+
 phpcr_document
 ~~~~~~~~~~~~~~
 
@@ -1370,7 +1375,7 @@ A service to use the generic initializer looks like this:
             arguments:
                 - AcmeContentBundle Basepaths
                 - { "%acme.content_basepath%", "%acme.menu_basepath%" }
-                - { "%acme.cnd%" }
+                - "%acme.cnd%"
             tags:
                 - { name: "doctrine_phpcr.initializer" }
 
@@ -1693,3 +1698,4 @@ Dumping nodes under ``/cms/simple`` including their properties:
 .. _`SQL2 queries`: http://www.h2database.com/jcr/grammar.html
 .. _`DoctrineCacheBundle`: https://github.com/doctrine/DoctrineCacheBundle/
 .. _`last modified listener cookbook entry`: http://docs.doctrine-project.org/projects/doctrine-phpcr-odm/en/latest/cookbook/last-modified.html
+.. _`BurgovKeyValueFormBundle`: https://github.com/Burgov/KeyValueFormBundle

components/routing/chain.rst

@@ -40,7 +40,7 @@ add the default Symfony2 router::
     $chainRouter->match('/foo/bar');
 
 Now, when the ``ChainRouter`` matches a request, it will ask the Symfony2
-``Router`` to match see if it matches. If there is no match, it will throw a
+``Router`` to see if the request matches. If there is no match, it will throw a
 :class:`Symfony\\Component\\Routing\\Exception\\ResourceNotFoundException`.
 
 If you add a new router, for instance the ``DynamicRouter``, it will be

contributing/code.rst

@@ -4,7 +4,13 @@ Contributing
 The Symfony2 CMF team follows all the rules and guidelines of the core
 Symfony2 `development process`_.
 
-When creating Pull Requests, please follow the Symfony `Submitting a Patch`_ guidlines.
+When creating Pull Requests, please follow the Symfony `Submitting a Patch`_
+guidelines.
+
+.. tip::
+
+    See :doc:`commits` for the commit conventions used by the Symfony CMF
+    team.
 
 Resources / Links
 -----------------
@@ -25,4 +31,4 @@ Resources / Links
 .. _`IRC channel`: irc://freenode/#symfony-cmf
 .. _`Users mailing list`: http://groups.google.com/group/symfony-cmf-users
 .. _`Devs mailing list`: http://groups.google.com/group/symfony-cmf-devs
-.. _`Submitting a Patch`: http://symfony.com/doc/current/contributing/code/patches.html
+.. _`Submitting a Patch`: http://symfony.com/doc/current/contributing/code/patches.html

contributing/commits.rst

@@ -0,0 +1,110 @@
+Commit Conventions
+==================
+
+The Symfony CMF uses a convention for the commits. This isn't a requirement
+when contributing to the CMF, but it is created to have meaningfull commits
+for big new features.
+
+Squashing
+---------
+
+Before a Pull Request is merged, the commits should be squashed (i.e. there
+should be a single commit in the Pull Request with all your work in it).
+
+You can easily squash a commit using `git rebase` as follows:
+
+.. code-block:: bash
+
+    $ git rebase --interactive HEAD~<number of commits in your pull request>
+
+For example, if your pull request on github has 4 commits:
+
+.. code-block:: bash
+
+    $ git rebase --interactive HEAD~4
+
+You will then be presented with a screen in your editor which looks something
+like this:
+
+.. code-block:: bash
+
+    pick 5d4530b port features from simple cms into routing bundle to simplify things
+    pick 1a0eea3 cs fixes and cleanups according to feedback
+    pick 8cbab56 convert settings to options
+    pick 8f3e4f9 cleanups for the options refactoring
+
+Tell github to pick the first one and squash the rest as follows:
+
+.. code-block:: bash
+
+    pick 5d4530b port features from simple cms into routing bundle to simplify things
+    s 1a0eea3 cs fixes and cleanups according to feedback
+    s 8cbab56 convert settings to options
+    s 8f3e4f9 cleanups for the options refactoring
+
+Save the file and quit. GIT should now squash all your commits and ask you
+for a new commit message.
+
+Commit Message
+--------------
+
+The commit message should be formatted as follows:
+
+.. code-block:: text
+
+    [<scope>] <short description>
+
+    Fixes: <list of issues fixed>
+
+    <long description>
+
+    BC Breaks (as required)
+    ---------
+
+    <list of BC breaks and required migrations>
+
+    Deprecations (as required)
+    ------------
+
+    <list of deprecations>
+
+For example, the commit message of a PR fixing 2 issues and adding 2 BC breaks
+would be:
+
+.. code-block:: text
+
+    [Initializer] Initializers use ManagerRegistry
+
+    Fixes: #1234, #4321
+
+    Initializers are now passed an instance of `ManagerRegistry` instead
+    of the `Phpcr\Session`. This means that initializers can retrieve both
+    the PHPCR session and the `DocumentManager`.
+
+    This PR also introduces a requirement that all initializers provide a name
+    which can be used in diagnostics.
+
+    BC Breaks
+    ---------
+
+    - The `init` method of the InitializerInterface now accepts a
+      `ManagerResistry` instead of a `PhpcrSession`. The PHPCR session can
+      be retrieved using `$registry->getConnection` and the manager with
+      `$registry->getManager()`;
+
+    - The first argument to the `GenericInitializer` constructor is now the
+      name of the initializer.
+
+Short Commit Message
+~~~~~~~~~~~~~~~~~~~~
+
+Not all Pull Requests require this much information for the commit. In most
+cases, a more simpler commit convention is enough:
+
+.. code-block:: text
+
+    <bug|feature|minor> [<scope>] <short description>
+
+Where ``bug`` refers to a commit fixing bugs, ``feature`` to a commit adding
+features and ``minor`` to commits adding less relevant things (fixing code
+standard, adding comments, fixing typos, etc.).

contributing/index.rst

@@ -5,6 +5,7 @@ Contributing
     :hidden:
 
     code
+    commits
     bundles
     releases
     license