Skip to content

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

Closed
wants to merge 3 commits into from

Conversation

javiereguiluz
Copy link
Member

We need some official doc about Flex as soon as possible. Later we'll add more articles about it as needed. Thanks!

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:
Copy link
Contributor

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:
Copy link
Contributor

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?

@javiereguiluz
Copy link
Member Author

@GuilhemN thanks for your review! All is fixed now.

@xabbuh xabbuh added this to the 3.3 milestone Jul 9, 2017
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[...] looks in this [...]

Copy link
Member Author

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.
Copy link
Member

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
Copy link
Member

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?

Copy link
Member Author

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.

@xabbuh
Copy link
Member

xabbuh commented Jul 21, 2017

Thank you Javier.

xabbuh added a commit that referenced this pull request Jul 21, 2017
…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
xabbuh added a commit that referenced this pull request Jul 21, 2017
@xabbuh xabbuh closed this Jul 21, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants