Skip to content

Commit 8c9df7b

Browse files
committed
Fixed first wave of errors.
1 parent c7a3b09 commit 8c9df7b

File tree

1 file changed

+25
-26
lines changed

1 file changed

+25
-26
lines changed

cookbook/bundles/installation.rst

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Most bundles provide a documentation of installation. However, most
88
steps are common for any bundle.
99

1010
Add composer dependencies
11-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11+
-------------------------
1212

13-
Starting from Symfony2.1 dependencies are managed via Composer. It's
14-
a good idea to learn some basics of Composer here:
15-
http://getcomposer.org/doc/00-intro.md.
13+
Starting from Symfony2.1 dependencies are managed with Composer. It's
14+
a good idea to learn some basics of Composer in
15+
`their documentation`_.
1616

17-
Before you can use composer to install a bundle you should look for a
17+
Before you can use composer to install a bundle, you should look for a
1818
`Packagist`_ package of that bundle. For example, for the
1919
`FOSUserBundle`_ you should look for a
2020
``friendsofsymfony/user-bundle`` package and it does exists:
@@ -25,25 +25,25 @@ https://packagist.org/packages/friendsofsymfony/user-bundle.
2525
Packagist is the main archive for Composer. If you are searching
2626
for a bundle, the best thing you can do is check out
2727
`KnpBundles`_, it is the unofficial achive of Symfony Bundles. If
28-
a bundle contains a README file, it is displayed there and if it
28+
a bundle contains a ``README`` file, it is displayed there and if it
2929
has a Packagist package it shows a link to the package. It's a
3030
really usefull site to begin searching for bundles.
3131

3232
Now you have the package name, you should determine the version you
3333
want to use. Usually different versions of a bundle correspond to a
34-
particular version of Symfony, this should be in the README file (in
34+
particular version of Symfony, this should be in the ``README`` file (in
3535
the Package, which you can view on Github or KnpBundles). If it isn't
36-
in the README, you can use the version you want. In the case of
37-
FOSUserBundle README file has a caution that version 1.2.0 must be
36+
in the ``README``, you can use the version you want. In the case of the
37+
FOSUserBundle, the ``README`` file has a caution that version 1.2.0 must be
3838
used for Symfony2.0 and 1.3 for Symfony2.1+. Let's use development
3939
version for this exmaple.
4040

41-
Now we can add the bundle to our composer.json file and update the
41+
Now we can add the bundle to our ``composer.json`` file and update the
4242
dependencies. You can do this manually:
4343

4444
1. **Add it to the ``composer.json`` file:**
4545

46-
.. code-block:: javascript
46+
.. code-block:: json
4747
4848
{
4949
...,
@@ -72,14 +72,12 @@ Or you can do this in one command:
7272
$ php composer.phar require friendsofsymfony/user-bundle:dev-master
7373
7474
Enable the bundle
75-
~~~~~~~~~~~~~~~~~
75+
-----------------
7676

7777
Now the bundle is installed into our Symfony project (in
78-
vendor/friendsofsymfony/) and the autoloader recognises this
78+
``vendor/friendsofsymfony/``) and the autoloader recognises this
7979
bundle. The only thing we need to do now is registering the bundle in
80-
the AppKernel:
81-
82-
.. code-block:: php
80+
the ``AppKernel``::
8381

8482
// app/AppKernel.php
8583

@@ -88,10 +86,10 @@ the AppKernel:
8886
{
8987
// ...
9088

91-
public function registerBundles()
92-
{
93-
$bundles = array(
94-
...,
89+
public function registerBundles()
90+
{
91+
$bundles = array(
92+
// ...,
9593
new FOS\UserBundle\FOSUserBundle(),
9694
);
9795

@@ -100,10 +98,10 @@ the AppKernel:
10098
}
10199

102100
Configure the bundle
103-
~~~~~~~~~~~~~~~~~~~~
101+
--------------------
104102

105103
Usually bundles require some configuration to be added to app's
106-
app/config/config.yml file. Bundle's documentation will likely
104+
``app/config/config.yml`` file. Bundle's documentation will likely
107105
describe that configuration. But you can also get a reference of the
108106
bundle's config via ``config:dump-reference`` command.
109107

@@ -134,8 +132,9 @@ The output will look like this:
134132
java: /usr/bin/java
135133
node: /usr/local/bin/node
136134
node_paths: []
137-
...
135+
# ...
138136
139-
.. _Packagist: https://packagist.org
140-
.. _FOSUserBundle: https://github.com/FriendsOfSymfony/FOSUserBundle
141-
.. _KnpBundles: http://knpbundles.com/
137+
.. _their documentation: http://getcomposer.org/doc/00-intro.md
138+
.. _Packagist: https://packagist.org
139+
.. _FOSUserBundle: https://github.com/FriendsOfSymfony/FOSUserBundle
140+
.. _KnpBundles: http://knpbundles.com/

0 commit comments

Comments
 (0)