[WIP][Cookbook] Document how to install 3th party bundles #2404
Conversation
| steps are common for any bundle. | ||
|
|
||
| Add composer dependencies | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| How to install 3rd party bundles | ||
| ================================ | ||
|
|
||
| Most bundles provide a documentation of installation. However, most |
There was a problem hiding this comment.
Most bundles provide their own installation instructions.
| How to install 3rd party bundles | ||
| ================================ | ||
|
|
||
| Most bundles provide their own installation instructions. However the |
| `Packagist`_ package of that bundle. For example, for the | ||
| `FOSUserBundle`_ you should look for a | ||
| ``friendsofsymfony/user-bundle`` package and it does exists: | ||
| https://packagist.org/packages/friendsofsymfony/user-bundle. |
There was a problem hiding this comment.
I think we get some conflict with the dot here. Add a space between the link and the dot
| ..., | ||
| "require": { | ||
| ..., | ||
| "friendsofsymfony/user-bundle": "dev-master" |
There was a problem hiding this comment.
This conflict with the fact that you mention 1.3 above. FOSUserBundle dev-master is not 1.3 but 2.0.x-dev
And please don't advocate the dev-master requirement. As soon as a bundle provides a branch alias, it is better to use it rather than requiring dev-master. It will be safer if the bundle introduces a BC break in master (assuming they bump the branch alias properly of course).
So here, you should be requiring either 1.3.* or 2.0.*@dev
There was a problem hiding this comment.
Btw, Packagist uses the branch alias when displaying the require statement for the package version when it exists.
[WIP][Cookbook] Document how to install 3th party bundles
|
Hi Pavel! Really nice work here! I proofread it and made some tweaks (at sha: c4b754e), but it's quite good. If you notice any issues in my changes, please let me know! Thanks! |
|
@weaverryan Hi Ryan. Thank you! I checked the docs on symfony.com, and I can see this topic in 2.1 (but not in 2.2+) so I guess that the "next weekly release" has happened. On the other hand, the Contributing guide tells that commits are going to be propagated up on every release. Looks like I don't understand something. I'm going to keep contributing so would be nice to clearly understand this nuance. |
|
We need to merge the branches ourselves. That means that Ryan is doing that around once a week. Some times, you need to wait longer, sometimes you're lucky :) However, you're document isn't lost. You will see it on the site soon :) |
|
Ah, now it's clear. Thanks Wouter! |
Based ob this answer by Wouter J: http://stackoverflow.com/questions/13338692/how-do-you-register-bundles-in-symfony2-1-designed-for-older-versions-of-symfony/13340180#13340180
I used FOSUserBundle for an example as it is wider known.
For config:dump-reference command i used AsseticBundle because FOSUserBundle requires more effort to start working (mainly creating model classes). And it will be easier for new users to test with AsseticBundle.