Skip to content
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

Updating library/bundle install docs to use "require" #4290

Merged
merged 4 commits into from
Oct 18, 2014
Merged

Conversation

weaverryan
Copy link
Member

Q A
Doc fix? yes
New docs? no
Applies to 2.3+
Fixed tickets -

As of composer/composer#3906, you can now simply install a library via:

php composer.phar require myname/my-lib

The latest version if chosen for you. I've replaced all mentions of modifying composer.json and running composer update with using the require command. I think the result is much simpler :).

Thanks!

.. _FOSUserBundle: https://github.com/FriendsOfSymfony/FOSUserBundle
.. _`friendsofsymfony/user-bundle`: https://packagist.org/packages/friendsofsymfony/user-bundle
.. _KnpBundles: http://knpbundles.com/
Copy link
Member

Choose a reason for hiding this comment

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

must be changed to _KnpBundles.com

@wouterj
Copy link
Member

wouterj commented Oct 4, 2014

👎 for the reason I mentioned here: #4267 (comment)

@stof
Copy link
Member

stof commented Oct 4, 2014

@wouterj this is a case against using require without version, not against using require itself.

@wouterj
Copy link
Member

wouterj commented Oct 4, 2014

@stof indeed. This PR does 2 things:

  1. Using the require command
  2. Removing versions from the require command

I'm +1 for (1) and -1 for (2).

@weaverryan
Copy link
Member Author

Hi guys! I agree with Wouter, so I've re-added the version back on several places. When we're giving people docs on how to use a library, then we should have a version, just in case they come out with a new version that's incompatible with our docs. But in other places, if we're just saying "you can install this library" and provide no other details, then I don't think we need the version there. I've updated the PR to reflect that and am merging it in. Thanks!

@weaverryan weaverryan merged commit d7ccbf3 into 2.3 Oct 18, 2014
weaverryan added a commit that referenced this pull request Oct 18, 2014
…weaverryan)

This PR was merged into the 2.3 branch.

Discussion
----------

Updating library/bundle install docs to use "require"

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3+
| Fixed tickets | -

As of composer/composer#3906, you can now simply install a library via:

```
php composer.phar require myname/my-lib
```

The latest version if chosen for you. I've replaced all mentions of modifying composer.json and running `composer update` with using the `require` command. I think the result is much simpler :).

Thanks!

Commits
-------

d7ccbf3 Re-adding one more version
ab2a688 [#4290] Re-adding version back
a174a2b Fixing bad link
1a7c4b9 Updating library/bundle installation docs to use the new composer require (no version) functionality
@xabbuh xabbuh deleted the composer-require branch October 18, 2014 19:44
weaverryan added a commit that referenced this pull request Oct 18, 2014
* 2.3:
  Putting #pull-request-format anchor link back, which we link to in our contrib notes
  Re-adding one more version
  [#4290] Re-adding version back
  Fixing bad link
  Updating library/bundle installation docs to use the new composer require (no version) functionality

Conflicts:
	components/dependency_injection/lazy_services.rst
	cookbook/bundles/installation.rst
weaverryan added a commit that referenced this pull request Oct 18, 2014
* 2.5:
  Putting #pull-request-format anchor link back, which we link to in our contrib notes
  Re-adding one more version
  [#4290] Re-adding version back
  Fixing bad link
  Updating library/bundle installation docs to use the new composer require (no version) functionality
  [#4233][#4094] Making validateValue and validate changes
  Minor tweaks and a missing location thanks to xabbuh and WouterJ
  Fixes thanks to @xabbuh
  Adding a section about keeping BC in a re-usable bundle
  Adding details about the 2.4 API as comments
  added a versionadded comment to Callback.rst
  Update custom_contraint.rst to meet the new 2.5 api
  Don't use deprecated functions in Callback.rst
  Update Callback.rst
  Replace addViolationAt (deprecated) by buildViolation
wouterj added a commit that referenced this pull request Oct 26, 2014
* Added interlinking between the application bundles best practices and this article (which is about reusable bundles)
* Readded the version. It seems like this one was missed when reverting ([ref](#4290))
wouterj added a commit to wouterj/symfony-docs that referenced this pull request Oct 26, 2014
It seems like this one was missed when reverting the change. For the
discussion, see symfony#4290
wouterj added a commit to wouterj/symfony-docs that referenced this pull request Oct 31, 2014
It seems like this one was missed when reverting the change. For the
discussion, see symfony#4290
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