Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
0b442c7
[quick_tour] simplified drastically the first two sections of "The Bi…
javiereguiluz Jan 30, 2014
6e5a6a2
[quick_tour] simplified the "routing" section
javiereguiluz Jan 31, 2014
63f671c
[quick_tour] updated the "Controllers" section
javiereguiluz Jan 31, 2014
8a1db94
[quick_tour] updated some screenshots
javiereguiluz Jan 31, 2014
b6c1721
[quick_tour] finished the review of "The Big Picture" chapter
javiereguiluz Jan 31, 2014
7c8c38c
[quick_tour] updated "the view" chapter
javiereguiluz Feb 1, 2014
be8787c
[quick tour] simplified "the controller" chapter
javiereguiluz Feb 1, 2014
3a2fd71
[quick_tour] simplified "the architecture" chapter
javiereguiluz Feb 1, 2014
f48cbf1
[quick_tour] second pass to the "big picture" chapter
javiereguiluz Feb 3, 2014
905e3e6
[quick tour] second pass to "the view" chapter
javiereguiluz Feb 3, 2014
cce8145
[quick_tour] second pass to "the controller" chapter and
javiereguiluz Feb 4, 2014
1e1deb0
[quick_tour] second pass to "the architecture" chapter
javiereguiluz Feb 4, 2014
f57ad39
[quick_tour] replaced "chapter" by "part" in some tutorial parts
javiereguiluz Feb 4, 2014
0d4da93
[quick_tour] removed inline links
javiereguiluz Feb 9, 2014
deced02
Bundle names should not be placed in literals
javiereguiluz Feb 9, 2014
53ba9d5
Removed a wrongly inserted comma
javiereguiluz Feb 9, 2014
4a4635d
When using server:run command, it's not necessary to add the `app_dev…
javiereguiluz Feb 9, 2014
89c7dd3
Capitalized some sentences that come after a colon
javiereguiluz Feb 9, 2014
bd1fc95
Added a new headline to better structure the documentation
javiereguiluz Feb 9, 2014
7cfc1d9
Minor rewording
javiereguiluz Feb 9, 2014
a22d663
Fixed the capitalization of a section heading
javiereguiluz Feb 9, 2014
9f04dae
Replaced "variable" by "placeholder" when using {_format} inside a route
javiereguiluz Feb 9, 2014
f810f4a
Removed the animated GIF showing how to install Symfony
javiereguiluz Feb 9, 2014
cef3103
Added a more useful message for users that don't have PHP 5.4
javiereguiluz Feb 16, 2014
1ed3dc9
Grammar fixes proposed by @weaverryan and @WouterJ
javiereguiluz Feb 16, 2014
c7d3fac
Restored the original line that explained how a routing file is imported
javiereguiluz Feb 16, 2014
fa1d018
Restored all the original introductions for each tutorial part
javiereguiluz Feb 16, 2014
304d4ce
[quick_tour] rewording and grammar fixes suggested by @weaverryan
javiereguiluz Feb 18, 2014
3b430f8
[quick_tour] more rewording and grammar fixes
javiereguiluz Feb 18, 2014
c911698
[quick_tour] removed an unneeded comma
javiereguiluz Feb 18, 2014
ef88ae2
[quick_tour] rewording and grammar fixes noted by @xabbuh
javiereguiluz Feb 19, 2014
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[quick_tour] second pass to the "big picture" chapter
  • Loading branch information
javiereguiluz committed Feb 4, 2014
commit f48cbf100d933a0268f9cbb519baf3e0a7d729fb
22 changes: 12 additions & 10 deletions quick_tour/the_big_picture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Installing Symfony2
-------------------

First, check that the PHP version installed on your computer meets the Symfony2
requirements: 5.3.3 or higher. Then, open a command console and execute the
following command to install the latest version of Symfony2 in the ``myproject/``
requirements: 5.3.3 or higher. Then, open a console and execute the following
command to install the latest version of Symfony2 in the ``myproject/``
directory:

.. code-block:: bash
Expand Down Expand Up @@ -145,7 +145,7 @@ will be executed. In the next section, you'll learn exactly what that means.

.. tip::

In addition to YAML format, routes can be configured in XML or PHP files
In addition to YAML files, routes can be configured in XML or PHP files
and even embedded in PHP annotations. This flexibility is one of the main
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[...] and can even be embedded [...]

features of Symfony2, a framework that never imposes you a particular
configuration format.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

configuration format -> format (it's not only flexible with config formats)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this tip block only talks about configuration formats, don't you think it's easier to understand if we only refer to configuration formats? In the view chapter we'll remind the user that he/she can user PHP format or Twig format for example.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a framework that never imposes a particular configuration format on you.

Expand All @@ -162,7 +162,7 @@ controller might create the response by hand, based on the request::

use Symfony\Component\HttpFoundation\Response;

$name = $request->query->get('name');
$name = $request->get('name');

return new Response('Hello '.$name);

Expand Down Expand Up @@ -322,11 +322,13 @@ environment.

.. _quick-tour-big-picture-environments-intro:

So what *is* an environment? An :term:`Environment` is a simple string (e.g.
``dev`` or ``prod``) that represents a group of configuration that's used
to run your application.
So what *is* an environment? An :term:`Environment` represents a group of
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put a new headline before this paragraph

configuration that's used to run your application. Symfony2 defines by default
two environments: ``dev`` (suited for when developing the application locally)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Symfony2 defines two evironments by default:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it actually defines 3: dev, prod and test

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, but as we don't mention tests on this quick tour, I guess it's a fair concession if we forget about the special test environment.

and ``prod`` (optimized for when executing the application on production).

Typically, you put your common configuration in ``config.yml`` and override
Typically, the environments share a large amount of configuration options. For
that reason, you put your common configuration in ``config.yml`` and override
where necessary in the specific configuration file for each environment:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd move where necessary to the end of the sentence


.. code-block:: yaml
Expand All @@ -340,8 +342,8 @@ where necessary in the specific configuration file for each environment:
intercept_redirects: false

In this example, the ``dev`` environment loads the ``config_dev.yml`` configuration
file, which itself imports the global ``config.yml`` file and then modifies it by
enabling the web debug toolbar.
file, which itself imports the common ``config.yml`` file and then modifies it
by enabling the web debug toolbar.

When you visit the ``app_dev.php`` file in your browser, you're executing
your Symfony application in the ``dev`` environment. To visit your application
Expand Down