Refactor documentation - Do not add annotation configuration if you are using Symfony Flex #11838
Conversation
Do not add annotation routing configuration if your project uses Symfony Flex since the recipe already created the annotations.yaml file with the config inside.
best_practices/controllers.rst
Outdated
| 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 and if you are not using Symfony Flex, add the following | ||
| configuration to the annotation routing configuration file: |
There was a problem hiding this comment.
Great find with this. I think we can go further and fully assume Flex and reword this section to read something more like this:
To load routes defined as annotations in your controllers, run “composer require doctrine/annotations”. Thanks to the Flex recipe, a config/routes/annotations.yaml file will be created:
... show the file
... then continue on like normal with “This Configuration...”
There was a problem hiding this comment.
Should we spread this modification to other branches ?
If so, i guess i should duplicate the PR once you validate it ? Or will you be able to do it automatically ?
|
Status: needs work |
|
@weaverryan did you have time to review ? |
…nfiguration if you are using Symfony Flex (idetox, elescot) This PR was merged into the 4.3 branch. Discussion ---------- Refactor documentation - Do not add annotation configuration if you are using Symfony Flex Do not add annotation routing configuration if your project uses Symfony Flex since the recipe already added the annotations.yaml file with the config inside. <!-- If your pull request fixes a BUG, use the oldest maintained branch that contains the bug (see https://symfony.com/roadmap for the list of maintained branches). If your pull request documents a NEW FEATURE, use the same Symfony branch where the feature was introduced (and `master` for features of unreleased versions). --> Commits ------- 8557b34 Removing space before colon 5190b5e Refactor documentation assuming we use Symfony Flex e1521a0 Update controllers.rst
|
@idetox thanks for helping us improve this! I did some minor rewords while merging to mach Ryan's suggestions. |
Do not add annotation routing configuration if your project uses Symfony Flex since the recipe already added the annotations.yaml file with the config inside.