Merge pull request #477 from symfony-cmf/bundle-install

wouterj · wouterj · commit cc3fa0f42c82 · 2014-05-05T13:54:07.000+02:00
Bundle install
diff --git a/book/installation.rst b/book/installation.rst
@@ -60,13 +60,13 @@ and then get the Symfony CMF code with it (this may take a while):
 
 .. code-block:: bash
 
-    $ php composer.phar create-project symfony-cmf/standard-edition cmf ~1.1
-    $ cd cmf
+    $ php composer.phar create-project symfony-cmf/standard-edition <path-to-install> ~1.1
+    $ cd <path-to-install>
 
 .. note::
 
-    The path ``<path-to-install>`` should either inside your web server doc
-    root or configure a virtual host for ``<path-to-install>``.
+    The path ``<path-to-install>`` should either be inside your web server doc
+    root or you need to configure a virtual host for ``<path-to-install>``.
 
 This will clone the Standard Edition and install all the dependencies and run
 some initial commands. These commands require write permissions to the
@@ -89,7 +89,7 @@ from github:
     $ git clone git://github.com/symfony-cmf/symfony-cmf-standard.git <path-to-install>
     $ cd <path-to-install>
 
-You still need Composer to get the dependencies. To install or update the
+You still need Composer to get the dependencies. To get the correct
 dependencies, use the ``install`` command:
 
 .. code-block:: bash
diff --git a/bundles/block/introduction.rst b/bundles/block/introduction.rst
@@ -15,10 +15,8 @@ including the ability to edit them. See :doc:`types`.
 Installation
 ------------
 
-You can install the bundle in 2 different ways:
-
-* Use the official Git repository (https://github.com/symfony-cmf/BlockBundle);
-* Install it via Composer (``symfony-cmf/block-bundle`` on `Packagist`_).
+You can install this bundle `with composer`_ using the
+`symfony-cmf/block-bundle`_ package.
 
 .. _bundle-block-configuration:
 
@@ -383,7 +381,8 @@ Read on
 * :doc:`cache`
 * :doc:`relation_to_sonata_block_bundle`
 
-.. _`Packagist`: https://packagist.org/packages/symfony-cmf/block-bundle
+.. _`symfony-cmf/block-bundle`: https://packagist.org/packages/symfony-cmf/block-bundle
+.. _`with composer`: http://getcomposer.org
 .. _`Symfony CMF Sandbox`: https://github.com/symfony-cmf/cmf-sandbox
 .. _`prepended configuration`: http://symfony.com/doc/current/components/dependency_injection/compilation.html#prepending-configuration-passed-to-the-extension
 .. _`SonataBlockBundle`: https://github.com/sonata-project/SonataBlockBundle
diff --git a/bundles/content/introduction.rst b/bundles/content/introduction.rst
@@ -14,10 +14,8 @@ For an introduction see the ":doc:`../../book/static_content`" article of the
 Installation
 ------------
 
-You can install the bundle in 2 different ways:
-
-* Use the official Git repository (https://github.com/symfony-cmf/ContentBundle);
-* Install it via Composer (``symfony-cmf/content-bundle`` on `Packagist`_).
+You can install this bundle `with composer`_ using the
+`symfony-cmf/content-bundle`_ package.
 
 Usage
 -----
@@ -226,4 +224,5 @@ The ContentBundle also provides an Admin class to enable creating, editing and
 removing static content from the admin panel. To enable the admin, use the
 ``cmf_content.persistence.phpcr.use_sonata_admin`` setting.
 
-.. _`Packagist`: https://packagist.org/packages/symfony-cmf/content-bundle
+.. _`with composer`: http://getcomposer.org
+.. _`symfony-cmf/content-bundle`: https://packagist.org/packages/symfony-cmf/content-bundle
diff --git a/bundles/core/introduction.rst b/bundles/core/introduction.rst
@@ -20,10 +20,8 @@ defaults for most of the other CMF Bundles.
 Installation
 ------------
 
-You can install the bundle in 2 different ways:
-
-* Use the official Git repository (https://github.com/symfony-cmf/CoreBundle);
-* Install it via Composer (``symfony-cmf/core-bundle`` on `Packagist`_).
+You can install this bundle `with composer`_ using the
+`symfony-cmf/core-bundle`_ package.
 
 Sections
 --------
@@ -33,4 +31,5 @@ Sections
 * :doc:`templating`
 * :doc:`persistence`
 
-.. _`Packagist`: https://packagist.org/packages/symfony-cmf/core-bundle
+.. _`symfony-cmf/core-bundle`: https://packagist.org/packages/symfony-cmf/core-bundle
+.. _`with composer`: http://getcomposer.org
diff --git a/bundles/media/introduction.rst b/bundles/media/introduction.rst
@@ -40,10 +40,8 @@ persisted using Doctrine PHPCR-ODM, Doctrine ORM or something else.
 Installation
 ------------
 
-1. You can install the bundle in 2 different ways:
-
-  * Use the official Git repository (https://github.com/symfony-cmf/MediaBundle);
-  * Install it via Composer (``symfony-cmf/media-bundle`` on `Packagist`_).
+1. You can install the bundle via Composer (``symfony-cmf/media-bundle`` on
+   `Packagist`_).
 
 2. When using the file and image controller for downloading, uploading and
    displaying, add the following lines to the end of your routing file:
diff --git a/bundles/menu/introduction.rst b/bundles/menu/introduction.rst
@@ -150,7 +150,6 @@ For more information see the `rendering menus`_ section of the KnpMenuBundle doc
 
 .. _`KnpMenu`: https://github.com/knplabs/KnpMenu
 .. _`KnpMenuBundle`: https://github.com/knplabs/KnpMenuBundle
-
 .. _`with composer`: http://getcomposer.org
 .. _`rendering menus`: https://github.com/KnpLabs/KnpMenuBundle/blob/master/Resources/doc/index.md#rendering-menus
 .. _`symfony-cmf/menu-bundle`: https://packagist.org/packages/symfony-cmf/menu-bundle
diff --git a/bundles/routing/introduction.rst b/bundles/routing/introduction.rst
@@ -28,6 +28,12 @@ the application configuration.
 Finally this bundles provides route documents for Doctrine PHPCR-ODM and
 ORM, as well as a controller for redirection routes.
 
+Installation
+------------
+
+You can install this bundle `with composer`_ using the
+`symfony-cmf/routing-bundle`_ package.
+
 .. index:: RoutingBundle
 .. index:: Routing
 
@@ -97,6 +103,8 @@ For more information on Routing in the Symfony CMF, please refer to:
   for implementation details of the routers.
 * Symfony2's `Routing`_ component documentation.
 
+.. _`with composer`: http://getcomposer.org
+.. _`symfony-cmf/routing-bundle`: https://packagist.org/packages/symfony-cmf/routing-bundle
 .. _`RoutingBundle`: https://github.com/symfony-cmf/RoutingBundle#readme
 .. _`PHPCR-ODM`: http://www.doctrine-project.org/projects/phpcr-odm.html
 .. _`documentation for DependencyInjection tags`: http://symfony.com/doc/2.1/reference/dic_tags.html
diff --git a/bundles/search/introduction.rst b/bundles/search/introduction.rst
@@ -10,10 +10,8 @@ SearchBundle
 Installation
 ------------
 
-You can install the bundle in 2 different ways:
-
-* Use the official Git repository (https://github.com/symfony-cmf/SearchBundle);
-* Install it via Composer (``symfony-cmf/search-bundle`` on `Packagist`_).
+You can install this bundle `with composer`_ using the
+`symfony-cmf/search-bundle`_ package.
 
 Routing
 ~~~~~~~
@@ -49,4 +47,6 @@ Finally, add the relevant routing to your configuration
         return $collection;
 
 .. _`LiipSearchBundle`: https://github.com/liip/LiipSearchBundle
-.. _`Packagist`: https://packagist.org/packages/symfony-cmf/search-bundle
+.. _`symfony-cmf/search-bundle`: https://packagist.org/packages/symfony-cmf/search-bundle
+.. _`with composer`: http://getcomposer.org
+
diff --git a/bundles/simple_cms/introduction.rst b/bundles/simple_cms/introduction.rst
@@ -27,10 +27,8 @@ The `CMF website`_ is an application using the SimpleCmsBundle.
 Installation
 ------------
 
-You can install the bundle in 2 different ways:
-
-* Use the official Git repository (https://github.com/symfony-cmf/SimpleCmsBundle);
-* Install it via Composer (``symfony-cmf/simple-cms-bundle`` on `Packagist`_).
+You can install this bundle `with composer`_ using the
+`symfony-cmf/simple-cms-bundle`_ package.
 
 Sections
 --------
@@ -41,4 +39,6 @@ Sections
 
 .. _`Symfony CMF Standard Edition`: https://github.com/symfony-cmf/symfony-cmf-standard
 .. _`CMF website`: https://github.com/symfony-cmf/cmf-website/
-.. _`Packagist`: https://packagist.org/packages/symfony-cmf/simple-cms-bundle
+.. _`symfony-cmf/simple-cms-bundle`: https://packagist.org/packages/symfony-cmf/simple-cms-bundle
+.. _`with composer`: http://getcomposer.org
+
diff --git a/bundles/tree_browser/introduction.rst b/bundles/tree_browser/introduction.rst
@@ -17,10 +17,8 @@ This bundle consists of two parts:
 Installation
 ------------
 
-You can install the bundle in 2 different ways:
-
-* Use the official Git repository (https://github.com/symfony-cmf/TreeBrowserBundle);
-* Install it via Composer (``symfony-cmf/tree-browser-bundle`` on `Packagist`_).
+You can install this bundle `with composer`_ using the
+`symfony-cmf/tree-browser-bundle`_ package.
 
 Routing
 -------
@@ -252,7 +250,8 @@ For example, if your want to open a custom action:
                 ),
             ));
 
-.. _`Packagist`: https://packagist.org/packages/symfony-cmf/tree-browser-bundle
+.. _`symfony-cmf/tree-browser-bundle`: https://packagist.org/packages/symfony-cmf/tree-browser-bundle
+.. _`with composer`: http://getcomposer.org
 .. _`FOSJsRoutingBundle`: https://github.com/FriendsOfSymfony/FOSJsRoutingBundle
 .. _`admin_tree.js`: https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle/blob/master/Resources/views/Tree/tree.html.twig
 .. _`select_tree.js`: https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle/blob/master/Resources/views/Form/form_admin_fields.html.twig
diff --git a/components/routing/introduction.rst b/components/routing/introduction.rst
@@ -59,10 +59,10 @@ array or in the ``Request`` object attributes field.
 Installation
 ------------
 
-You can install the component in 2 different ways:
-
-* Use the official Git repository (https://github.com/symfony-cmf/Routing);
-* `Install it via Composer`_ (``symfony-cmf/routing`` on `Packagist`_).
+You can install this component `with composer`_ using the
+`symfony-cmf/routing`_ package. If you are using the
+``symfony-cmf/routing-bundle`` you do not need to specify the component
+separately, it is required automatically.
 
 Symfony2 integration
 --------------------
@@ -80,7 +80,7 @@ Sections
 * :doc:`dynamic`
 * :doc:`nested_matcher`
 
-.. _`Install it via Composer`: http://symfony.com/doc/current/components/using_components.html
-.. _`Packagist`: https://packagist.org/packages/symfony-cmf/routing
+.. _`with composer`: http://getcomposer.org
+.. _`symfony-cmf/routing`: https://packagist.org/packages/symfony-cmf/routing
 .. _`Routing chapter of the Symfony2 book`: http://symfony.com/doc/current/book/routing.html
 .. _`Routing Component`: http://symfony.com/doc/current/components/routing/introduction.html
diff --git a/cookbook/editions/cmf_sandbox.rst b/cookbook/editions/cmf_sandbox.rst
@@ -44,8 +44,8 @@ Apache Jackrabbit
 ~~~~~~~~~~~~~~~~~
 
 The Symfony CMF Sandbox uses Jackalope with Apache JackRabbit by default.
-Alternative storage methods can be configured, but this is the most tested,
-and should be the easiest to setup.
+If you do not have Java available, you can choose alternative storage
+methods (see below).
 
 You can get the latest Apache Jackrabbit version from the project's
 `official download page`_. To start it, use the following command
@@ -64,20 +64,43 @@ by specifying the port on the command line.
 For unix systems, you can get the start-stop script for ``/etc/init.d``
 `here`_.
 
-Getting the Sandbox Code
-~~~~~~~~~~~~~~~~~~~~~~~~
+Getting the Sandbox Code: Composer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The Symfony CMF Sandbox source code is available on github. To install it, do:
+The easiest way to install the CMF sandbox is is using `Composer`_. Get it using
 
 .. code-block:: bash
 
-    $ php composer.phar create-project symfony-cmf/sandbox cmf-sandbox ~1.1
+    $ curl -sS https://getcomposer.org/installer | php
 
-Move into the folder and copy the default configuration files:
+and then get the Symfony CMF code with it (this may take a while):
+
+.. code-block:: bash
+
+    $ php composer.phar create-project --no-install symfony-cmf/sandbox <path-to-install> ~1.1
+    $ cd <path-to-install>
+    $ mv ../composer.phar .
+
+Getting the Sandbox Code: GIT
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Alternatively you can get the sandbox from GIT. If you want to contribute to
+the sandbox, you need the GIT information. Just clone the repository from
+github:
+
+.. code-block:: bash
+
+    $ git clone git://github.com/symfony-cmf/cmf-sandbox.git <path-to-install>
+    $ cd <path-to-install>
+
+Configuration
+~~~~~~~~~~~~~
+
+Change into the root folder of the sandbox and copy the default configuration
+files:
 
 .. code-block:: bash
 
-    $ cd cmf-sandbox
     $ cp app/config/parameters.yml.dist app/config/parameters.yml
     $ cp app/config/phpcr_jackrabbit.yml.dist app/config/phpcr.yml
 
@@ -89,15 +112,10 @@ storage mechanism. You can modify them to better fit your needs
     The second configuration file refers to specific jackalope + jackrabbit
     configuration. There are other files available for different stack setups.
 
-Next, get composer and install and the necessary bundles (this may take a
-while):
+Next, use composer to install the necessary bundles (this may take a while):
 
 .. code-block:: bash
 
-    # get composer
-    $ curl -s http://getcomposer.org/installer | php --
-
-    # install bundles
     $ php composer.phar install
 
 .. note::
@@ -195,67 +213,14 @@ Doctrine DBAL setup:
     $ cd cmf-sandbox
     $ cp app/config/phpcr_doctrine_dbal.yml.dist app/config/phpcr.yml
 
-Next, you need to install the actual Doctrine DBAL bundle required by jackalope:
-
-.. code-block:: bash
-
-    $ php composer.phar require jackalope/jackalope-doctrine-dbal:dev-master
-
 And create and init your database:
 
 .. code-block:: bash
 
     $ php app/console doctrine:database:create
     $ php app/console doctrine:phpcr:init:dbal
 
-After this, your should follow the steps in `Preparing the PHPCR repository`_.
-
-Doctrine caching
-................
-
-Optionally, to improve performance, you can install DoctrineCacheBundle by
-typing the following command:
-
-.. code-block:: bash
-
-    $ php composer.phar require doctrine/cache-bundle:1.0.*
-
-And adding the following entry to your ``app/AppKernel.php``::
-
-    // app/AppKernel.php
-
-    // ...
-    public function registerBundles()
-    {
-      $bundles = array(
-          // ...
-          new Doctrine\Bundle\DoctrineCacheBundle\DoctrineCacheBundle(),
-          // ...
-      );
-    }
-
-Finally, uncomment the caches settings in the ``phpcr.yml`` as well as the
-``doctrine_cache`` settings in ``config.yml``.
-
-.. code-block:: yaml
-
-    # app/config/phpcr.yml
-    caches:
-        meta: doctrine_cache.providers.phpcr_meta
-        nodes: doctrine_cache.providers.phpcr_nodes
-
-.. code-block:: yaml
-
-    # app/config/config.yml
-
-    # ...
-
-    doctrine_cache:
-        providers:
-            phpcr_meta:
-                type: file_system
-            phpcr_nodes:
-                type: file_system
+After this, follow the steps in `Preparing the PHPCR repository`_.
 
 Midgard2 PHPCR Provider
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -306,6 +271,7 @@ or:
 After this, your should follow the steps in `Preparing the PHPCR repository`_
 to continue the installation process.
 
+.. _`Composer`: http://getcomposer.org
 .. _`CMF sandbox github repository`: https://github.com/symfony-cmf/cmf-sandbox
 .. _`Requirements for running Symfony2`: http://symfony.com/doc/current/reference/requirements.html
 .. _`Git 1.6+`: http://git-scm.com/
diff --git a/cookbook/installing_configuring_doctrine_phpcr_odm.rst b/cookbook/installing_configuring_doctrine_phpcr_odm.rst
