-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Tweak docs for Flex #8571
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.
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
Tweak docs for Flex #8571
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy to see this documentation growing, I have same tiny suggestions if you are willing to check them!
by default, but it will still be optional to use. | ||
as installing and removing bundles and other Composer dependencies. Symfony | ||
Flex works for Symfony 3.3 and newer versions. Starting from Symfony 4.0, Flex | ||
should be used by default, but it is optional to use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be used by default, but it is optional to use.
I'd say:
should be used by default, but it is still optional.
To to avoid the double "used/use"
SwiftmailerBundle and returns the "recipe" for it. | ||
|
||
Flex keeps tracks of which recipes it installed in a ``symfony.lock`` file that | ||
must be committed in your code repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rewrite to:
Flex keeps tracks of installed recipes in a ``symfony.lock`` file which must be committed in your code repository.
Just for better concordance
Symfony Flex as a dependency, so you can create a new Flex-enabled Symfony | ||
application executing the following command: | ||
project recommended to create new applications. This "skeleton" already | ||
includes Symfony Flex as a dependency, so you can create a new Flex-enabled |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
, so you can create a new
to
, thus you can create a new
and directory created by this recipe. | ||
remember names (``composer require mailer`` vs ``composer require | ||
symfony/swiftmailer-bundle``). The ``bundles`` option tells Flex in which | ||
environments should this bundle be enabled automatically (``all`` in this |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
environments should this bundle be enabled automatically
should be environments this bundle should be automatically enabled
This PR was merged into the 3.3 branch. Discussion ---------- Tweak docs for Flex I added a sentence about the new `symfony.lock` file and did some minor adjustments. Commits ------- 6d0d8f5 tweaked docs for Flex
Thanks for the review! I've made the suggested changes and merged :) |
* 3.3: more underlining! [#8571] Tweaks thanks to reviewers tweaked docs for Flex Update security.rst use .test instead of .dev as development domain Shortened command... easier to remember ;) Final updates Last fixes Restored the "Full Default Configuration" dump Fixed an indentation issue Simplified the framework configuration reference Added Doctrine entities and documents to the list of known locations for classes
* 3.4: more underlining! [#8571] Tweaks thanks to reviewers tweaked docs for Flex Update security.rst use .test instead of .dev as development domain updating controller scalar args for 3.4 Shortened command... easier to remember ;) Final updates Last fixes Restored the "Full Default Configuration" dump Fixed an indentation issue Simplified the framework configuration reference Added Doctrine entities and documents to the list of known locations for classes
I added a sentence about the new
symfony.lock
file and did some minor adjustments.