-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Added an introductory article for Symfony Flex #8115
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
Conversation
setup/flex.rst
Outdated
in a Flex-enabled application, Symfony can perform tasks before and after the | ||
execution of Composer tasks. | ||
|
||
Consider for example the following example: |
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 would remove for example
:)
setup/flex.rst
Outdated
~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Recipes are defined in a ``manifest.json`` file and can contain any number of | ||
other files and directories. For example, this is the full recipe for SwiftmailerBundle: |
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.
Isn't it just its manifest?
@GuilhemN thanks for your review! All is fixed now. |
setup/flex.rst
Outdated
two public repositories: | ||
|
||
* `Main recipe repository`_, is a curated list of recipes for high quality and | ||
maintained packages. Symfony Flex only looks for in this repository by default. |
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.
[...] looks 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.
Are we sure? I thought "look for" was the right verb here ... so "looks for in ..." instead of "looks in ..." In any case, I've made the change you proposed.
setup/flex.rst
Outdated
$ composer config extra.symfony.allow-contrib true | ||
|
||
Read the `Symfony Recipes documentation`_ to learn everything about how to | ||
created recipes for your own packages. |
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.
create
└── vendor/ | ||
|
||
This means that installing the ``symfony/flex`` dependency in your application | ||
is not enough. You must also upgrade the directory structure to the one showed |
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.
Shouldn't we explain the options you can use in your composer.json
file to adapt for alternative directory names instead?
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.
But that's not enough ... if you change the config dir ... Flex won't work because the config dir is correct ... but its contents are not.
Thank you Javier. |
…iluz) This PR was squashed before being merged into the 3.3 branch (closes #8115). Discussion ---------- Added an introductory article for Symfony Flex We need some official doc about Flex as soon as possible. Later we'll add more articles about it as needed. Thanks! Commits ------- dba7c3d Added an introductory article for Symfony Flex
We need some official doc about Flex as soon as possible. Later we'll add more articles about it as needed. Thanks!