Skip to content

Commit e71d368

Browse files
committed
Minor tweaks!
1 parent 40e2201 commit e71d368

File tree

5 files changed

+26
-22
lines changed

5 files changed

+26
-22
lines changed

configuration.rst

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -325,29 +325,32 @@ configure DoctrineBundle and other parts of Symfony:
325325
),
326326
));
327327
328-
But the ``parameters.yml`` file *is* special: it contains any value that you do
329-
not want to commit to your repository or that changes on each server. Database configuration
330-
is a perfect example of both.
328+
But the ``parameters.yml`` file *is* special: it defines the values that usually
329+
change on each server. For example, the database credentials on your local
330+
development machine might be different from your workmates. That's why this file
331+
is not committed to the shared repository and is only stored on your machine.
331332

332333
Because of that, **parameters.yml is not committed to your version control**. In fact,
333334
the ``.gitignore`` file that comes with Symfony prevents it from being committed.
334335

335336
However, a ``parameters.yml.dist`` file *is* committed (with dummy values). This file
336-
isn't read by Symfony: it's just a template for what keys the ``parameters.yml``
337-
file you should. If you add or remove keys to ``parameters.yml``, you should add
338-
and remove them from ``parameters.yml.dist``.
339-
340-
.. sidebar:: The Incenteev Parameter Handler
341-
342-
When you clone a new project, you will need to create the ``parameters.yml``
343-
file from the committed ``parameters.yml.dist`` file. To help with this, after
344-
you run ``composer install``, a script will automatically create this file by
345-
interactively asking you to supply the value for each key in ``parameters.yml.dist``.
346-
For more details - or to remove or control this behavior - see the
337+
isn't read by Symfony: it's just a reference so that Symfony knows which parameters
338+
need to be defined in the ``parameters.yml`` file. If you add or remove keys to
339+
``parameters.yml``, add or remove them from ``parameters.yml.dist`` too so both
340+
files are always in sync.
341+
342+
.. sidebar:: The Interactive Parameter Handler
343+
344+
When you :ref:`install an existing Symfony project <install-existing-app>`, you
345+
will need to create the ``parameters.yml`` file using the committed ``parameters.yml.dist``
346+
file as a reference. To help with this, after you run ``composer install``, a
347+
Symfony script will automatically create this file by interactively asking you
348+
to supply the value for each parameter defined in ``parameters.yml.dist``. For
349+
more details - or to remove or control this behavior - see the
347350
`Incenteev Parameter Handler`_ documentation.
348351

349-
Environments & the Other Config Files (e.g. config_dev.yml)
350-
-----------------------------------------------------------
352+
Environments & the Other Config Files
353+
-------------------------------------
351354

352355
You have just *one* app, but whether you realize it or not, you need it to behave
353356
*differently* at different times:
@@ -360,9 +363,8 @@ You have just *one* app, but whether you realize it or not, you need it to behav
360363

361364
How can you make *one* application behave in two different ways? With *environments*.
362365

363-
If you see the nice web debug toolbar at the bottom of your browser, then you're
364-
already running your application in the ``dev`` environment. After you deploy, you'll
365-
use the ``prod`` environment.
366+
You've probably already been using the ``dev`` environment without even knowing it.
367+
After you deploy, you'll use the ``prod`` environment.
366368

367369
To learn more about *how* to execute and control each environment, see
368370
:doc:`/configuration/environments`.

configuration/environments.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ either ``app.php`` (for the ``prod`` environment) or ``app_dev.php``
138138
139139
If you don't have *either* filename in your URL, then it's up to your web server
140140
to decide *which* file to execute behind the scenes. If you're using the built-in
141-
PHP web server, it knows use the ``app_dev.php`` file. On production, you'll
141+
PHP web server, it knows to use the ``app_dev.php`` file. On production, you'll
142142
:doc:`configure your web server </setup/web_server_configuration>` to use ``app.php``.
143143
Either way: *one of these two files is always executed*.
144144

page_creation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ Bundles are registered in your ``app/AppKernel.php`` file (a rare PHP file in th
208208

209209
For example, ``TwigBundle`` is responsible for adding the Twig tool to your app!
210210

211-
Eventually, you'll download and add more, third-party bundles to your app in order
211+
Eventually, you'll download and add more third-party bundles to your app in order
212212
to get even more tools. Imagine a bundle that helps you create paginated lists.
213213
That exists!
214214

routing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ for you to use in your controller (keep reading). The ``blog_show`` is the
9494
internal name of the route, which doesn't have any meaning yet and just needs
9595
to be unique. Later, you'll use it to generate URLs.
9696

97-
If you don't want to use annotations, you can also use Yaml, XML or PHP. In these
97+
If you don't want to use annotations, you can also use YAML, XML or PHP. In these
9898
formats, the ``_controller`` parameter is a special
9999
key that tells Symfony which controller should be executed when a URL matches
100100
this route. The ``_controller`` string is called the

setup.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,8 @@ you may use in your applications:
322322
* The `Symfony REST Edition`_ shows how to build an application that provides a
323323
RESTful API using the `FOSRestBundle`_ and several other related bundles.
324324

325+
.. _install-existing-app:
326+
325327
Installing an Existing Symfony Application
326328
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
327329

0 commit comments

Comments
 (0)