Don't use Flex shortcuts when installing packages #9742
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xabbuh
reviewed
May 8, 2018
doctrine.rst
Outdated
| @@ -23,8 +23,8 @@ code: | |||
|
|
|||
| .. code-block:: terminal | |||
|
|
|||
| composer require doctrine | |||
| composer require maker --dev | |||
| $ composer require doctrine/doctrine-bundle | |||
There was a problem hiding this comment.
By the way, why don't we use orm here instead? With this step the required doctrine/orm package would be missing leading to errors.
xabbuh
reviewed
May 8, 2018
doctrine.rst
Outdated
| @@ -479,7 +479,7 @@ for you automatically! First, install the bundle in case you don't have it: | |||
|
|
|||
| .. code-block:: terminal | |||
|
|
|||
| $ composer require annotations | |||
| $ composer require doctrine/annotations | |||
There was a problem hiding this comment.
That's not the same, annotations is an alias for the SensioFrameworkExtraBundle.
xabbuh
reviewed
May 8, 2018
doctrine/registration_form.rst
Outdated
| @@ -14,7 +14,7 @@ First, make sure you have all the dependencies you need installed: | |||
|
|
|||
| .. code-block:: terminal | |||
|
|
|||
| $ composer require doctrine form security validator | |||
| $ composer require doctrine/doctrine-bundle symfony/form symfony/security-bundle symfony/validator | |||
xabbuh
reviewed
May 8, 2018
page_creation.rst
Outdated
| @@ -195,15 +195,15 @@ To use the web debug toolbar, just install it: | |||
|
|
|||
| .. code-block:: terminal | |||
|
|
|||
| $ composer require --dev profiler | |||
| $ composer require --dev symfony/web-profiler-bundle | |||
xabbuh
reviewed
May 8, 2018
profiler.rst
Outdated
| @@ -12,7 +12,7 @@ install the profiler before using it: | |||
|
|
|||
| .. code-block:: terminal | |||
|
|
|||
| $ composer require profiler --dev | |||
| $ composer require symfony/web-profiler-bundle --dev | |||
xabbuh
reviewed
May 8, 2018
routing.rst
Outdated
| @@ -24,7 +24,7 @@ First, install the annotations package: | |||
|
|
|||
| .. code-block:: terminal | |||
|
|
|||
| $ composer require annotations | |||
| $ composer require doctrine/annotations | |||
xabbuh
reviewed
May 8, 2018
security.rst
Outdated
| @@ -136,7 +136,7 @@ You'll learn later how to deny access to certain URLs or controllers. | |||
|
|
|||
| .. code-block:: terminal | |||
|
|
|||
| $ composer require profiler --dev | |||
| $ composer require symfony/web-profiler-bundle --dev | |||
xabbuh
reviewed
May 8, 2018
serializer.rst
Outdated
| @@ -123,7 +123,7 @@ To use annotations, first install the annotations package: | |||
|
|
|||
| .. code-block:: terminal | |||
|
|
|||
| $ composer require annotations | |||
| $ composer require doctrine/annotations | |||
|
@xabbuh thanks for the review. I'm sorry I made so many mistakes. Hopefully they are fixed now! |
xabbuh
reviewed
May 9, 2018
| @@ -1,7 +1,7 @@ | |||
| .. note:: | |||
|
|
|||
| In order to use the annotation loader, you should have installed the | |||
| ``doctrine/annotations`` and ``doctrine/cache`` packages with Composer. | |||
| ``sensio/framework-extra-bundle`` and ``doctrine/cache`` packages with Composer. | |||
There was a problem hiding this comment.
I am not sure where we include this file, but is it needed in that context to have the SensioFrameworkExtraBundle or are these cases where doctrine/annotations is actually fine?
There was a problem hiding this comment.
We include this file in:
- /components/routing.rst
- /components/serializer.rst
- /components/validator/resources.rst
In 2.7, 2.8 and 3.4 we showed this recommendation:
.. note::
In order to use the annotation loader, you should have installed the
``doctrine/annotations`` and ``doctrine/cache`` packages with Composer.So let's keep it unchanged.
xabbuh
approved these changes
May 16, 2018
javiereguiluz
added a commit
that referenced
this pull request
May 16, 2018
…eguiluz) This PR was squashed before being merged into the 4.0 branch (closes #9742). Discussion ---------- Don't use Flex shortcuts when installing packages This fixes #9693. I've left some shortcuts on purpose: * in `frontend/encore/installation.rst`: `composer require encore` because Webpack Encore is a bit special and the shortcut is the best way to install it. * in `quick_tour/*.rst` because it shows the features provided by Symfony and shortcuts is one of those features. Readers will learn about them and later they'll decide if they want to use them or not. * in `setup/flex.rst` because they are used on purpose to talk about Flex shortcuts. Commits ------- 2495590 Don't use Flex shortcuts when installing packages
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes #9693. I've left some shortcuts on purpose:
frontend/encore/installation.rst:composer require encorebecause Webpack Encore is a bit special and the shortcut is the best way to install it.quick_tour/*.rstbecause it shows the features provided by Symfony and shortcuts is one of those features. Readers will learn about them and later they'll decide if they want to use them or not.setup/flex.rstbecause they are used on purpose to talk about Flex shortcuts.