Skip to content

Refactor documentation - Do not add annotation configuration if you are using Symfony Flex #11838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 20, 2019
Merged

Refactor documentation - Do not add annotation configuration if you are using Symfony Flex #11838

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1521a0
Update controllers.rst
idetox Jun 27, 2019
5190b5e
Refactor documentation assuming we use Symfony Flex
Jul 1, 2019
8557b34
Removing space before colon
idetox Jul 3, 2019
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
13 changes: 9 additions & 4 deletions best_practices/controllers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,19 @@ this suffix is neither required nor recommended, so you can safely remove it.
Routing Configuration
---------------------

To load routes defined as annotations in your controllers, add the following
configuration to the main routing configuration file:
To load routes defined as annotations in your controllers, run the following command:

.. code-block:: terminal

$ composer require doctrine/annotations

Thanks to the :doc:`Flex recipe</setup/flex>`, a ``config/routes/annotations.yaml`` file will be created:

.. code-block:: yaml

# config/routes.yaml
# config/routes/annotations.yaml
controllers:
resource: '../src/Controller/'
resource: '../../src/Controller/'
type: annotation

This configuration will load annotations from any controller stored inside the
Expand Down